Improve docstrings for Pydantic models #505
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #505 +/- ##
==========================================
+ Coverage 82.92% 83.32% +0.40%
==========================================
Files 27 27
Lines 1540 1577 +37
==========================================
+ Hits 1277 1314 +37
Misses 263 263
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
ponyisi
force-pushed
the
303_model_help
branch
from
a723fc1 to
3b9db2d
Compare
|
Can you document this Pydantic design decision in the PR? @gordonwatts - I'm going to wait for you to verify your docstring woes |
|
BenGalewsky
approved these changes
Nov 14, 2024
BenGalewsky
force-pushed
the
303_model_help
branch
from
3b9db2d to
1c718eb
Compare
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.
Pydantic model classes had completely unhelpful docstrings. This is a design decision by the Pydantic folks, but they provide a workaround (the ability to change the
__doc__attribute via a post-initialization hook - see pydantic/pydantic#638 (comment)). This is implemented. Resolves #303