-
Notifications
You must be signed in to change notification settings - Fork 198
Enforce working examples in docstrings and documentation #1588
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
Open
strawgate
wants to merge
8
commits into
pydantic:main
Choose a base branch
from
strawgate:add-pytest-examples
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+697
−461
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
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
1a46a09 to
5fe8ece
Compare
5fe8ece to
a23907e
Compare
alexmojaki
reviewed
Jan 7, 2026
Contributor
Author
|
Hey sorry, should have left this in draft, I'll pick this back up and get it ready to be merged |
Contributor
Author
|
@alexmojaki thanks for the review, I think this is looking better now. |
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.
Require formatted and runnable examples in docstrings and documentation, and bring the documentation and code up to compliance with these new requirements. Closes #1587
Uses
pytest-examplesto ensure that examples in docstrings and documentation are properly formatted and runnable with assertions on anyprintstatements in the example. Addspytest-timeoutto the dev dependencies which is used to prevent example tests from running forever if they hit blocking code.There are zero lines of actual code changed outside the
test_docs.py. The majority of the PR is imports organization, linting, formatting, and ensuring that examples are runnable or ensuring we skip examples that should not be linted or that should not be run (either because they are incomplete examples, require internet access or an external connection, or are blocking).There are ~300 newly passing tests and ~140 skipped tests (examples that are not checked for formatting or if they are runnable).