Skip to content

Conversation

@adamraine
Copy link
Contributor

Fixes #13825

@adamraine adamraine requested a review from a team as a code owner April 6, 2022 15:33
@adamraine adamraine requested review from connorjclark and removed request for a team April 6, 2022 15:33
Copy link
Collaborator

@connorjclark connorjclark left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

any chance you'd like to move this code into recipes and make a test that runs via yarn test-docs ?

@adamraine
Copy link
Contributor Author

any chance you'd like to move this code into recipes and make a test that runs via yarn test-docs ?

We already exercise the flow api in the sample json test. Even if we made a doc specific test, it would still be possible for the doc snippets and test to get out of sync.

@adamraine adamraine changed the title docs(user-flows): update usage of generateReport docs(user-flows): update api usage Apr 6, 2022
@connorjclark
Copy link
Collaborator

Even if we made a doc specific test, it would still be possible for the doc snippets and test to get out of sync.

The purpose of the docs test is that we provide starting code that works, and can be confident that we never break that (and don't need to constantly manually verify it / wait for a user to report a bug). As the linked issue shows, we had code in docs that was old, which 1) something as minimal as type checking would have caught and 2) a full end-to-end test, like other recipes, would have caught.

For these docs in particular we just need to remember them as we make any other high level API changes, so I'm not suggesting it's worth the effort to do this. For other recipes it def. was (since maybe something lower level could break them)

@adamraine
Copy link
Contributor Author

For these docs in particular we just need to remember them as we make any other high level API changes, so I'm not suggesting it's worth the effort to do this. For other recipes it def. was (since maybe something lower level could break them)

It might be worth it, I would like to do it in a separate PR though.

@adamraine adamraine merged commit 586d4a2 into master Apr 6, 2022
@adamraine adamraine deleted the flow-docs branch April 6, 2022 20:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

TypeError 'ERR_INVALID_ARG_TYPE' trying to create report from user-flow

3 participants