chore: Update usage example to be consistent with docs - #130
Merged
awalker4 merged 1 commit intoJul 14, 2024
Merged
Conversation
Copy link
Copy Markdown
Collaborator
Sorry, something went wrong.
The autogenerated example is inconsistent with our hosted docs. Remove this section and copy the usage snippet from the docs. Also, add a note for the new page range feature.
awalker4
marked this pull request as ready for review
July 13, 2024 21:45
awalker4
enabled auto-merge (squash)
July 13, 2024 21:47
Coniferish
approved these changes
Jul 14, 2024
Coniferish
left a comment
Copy link
Copy Markdown
Contributor
There was a problem hiding this comment.
LGTM.
But I'm also wondering if there's a way for us to continue generating this (and other examples) without them being readily findable by users so we can continue to see how the generated examples change and monitor if there are any significant changes we need to then note in our docs.
Sorry, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Reviewers
1 more reviewer2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The autogenerated example is inconsistent with our hosted docs. Remove this section and copy the usage snippet from the docs. Also, add a note for the new page range feature.