If available, use docstrings from properties for field descriptions #698
Conversation
This file contains 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
@@ Coverage Diff @@
## master #698 +/- ##
=======================================
Coverage 98.80% 98.80%
=======================================
Files 64 64
Lines 7253 7261 +8
=======================================
+ Hits 7166 7174 +8
Misses 87 87
Continue to review full report at Codecov.
|
tfranzel
added a commit
that referenced
this pull request
Mar 4, 2023
tfranzel
added a commit
that referenced
this pull request
Mar 4, 2023
…954) * Use dosctrings from properties for field descriptions if available * add test, modify impl details of #698 --------- Co-authored-by: Luke Plant <[email protected]> Co-authored-by: T. Franzel <[email protected]>
|
resolved and superceded by #954 |
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.
Should be self-explanatory from the tests. This can be a big help in transferring knowledge from docstrings into the schema for frontend developers.
There was one issue with
partialthat the test suite found, I just added a special case top deal with that. Otherwise you get things likedescription: partial(func, *args, **keywords) - new function with partial application of the given arguments and keywordswhich is unhelpful noise.