-
Notifications
You must be signed in to change notification settings - Fork 6
Run tests against the python code in our documentation #35
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Conversation
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
mjvogelsong
commented
Apr 3, 2023
| For example, say you want to set your desired confidence level to 0.95, but that you're willing to wait up to 60 seconds to get a confident response. | ||
|
|
||
| ```python | ||
| <!-- TODO: turn on `confidence` parameter, and re-enable tests! --> |
Contributor
Author
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Gotta fix this
tyler-romero
approved these changes
Apr 3, 2023
Contributor
tyler-romero
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
We can test the code block examples in our docs using pytest-markdown-docs! This should help us make sure our documentation examples are always runnable.
One open question is whether it is better to make most/every example a complete example? As a user of SDK docs, I kinda prefer that, because then every code block becomes fully-functional without any assumptions. We can highlight the "important" part of the code. But I do also think there's value in having shorter code snippets to focus on the important part. There is a
python continuationfence that we can use to test against a series of python blocks.TODOs:
confidenceparameter inget_or_create_detector(). Gotta fix that.assertsinline with the code blocks, but not render them...