Fix various docstrings using fixed pytest-examples #6607
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 bidir
8000
ectional Unicode characters
adriangb
approved these changes
Jul 11, 2023
Deploying with
|
| Latest commit: |
d29704d
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://40fb656c.pydantic-docs2.pages.dev |
| Branch Preview URL: | https://fix-docstrings.pydantic-docs2.pages.dev |
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.
There was a bug where single-line docstrings were causing files to be mishandled by pytest-examples.
With this PR pydantic/pytest-examples#15, these get caught, and as a result I was able to find these issues.
Also I'll note that this other PR pydantic/pytest-examples#14 makes it so that we can run
pytest --update-examplesand it doesn't produce any invalid example updates that need to be reverted.I've opened this as a draft because I don't think we should merge this PR until we can update pytest-examples, so this can serve as a reminder that we need to do that.