docs: Autodoc typehints #1710
Merged
docs: Autodoc typehints #1710
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
BobDotCom
added
documentation
|
Note: ATM, we cannot set return descriptions without setting a return type |
|
Most/all return type annotations should be removed in the future, once it's supported |
Lulalaby
previously approved these changes
Nov 7, 2022
Lulalaby
approved these changes
Nov 7, 2022
|
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## master #1710 +/- ##
=======================================
Coverage 33.14% 33.14%
=======================================
Files 96 96
Lines 18513 18514 +1
=======================================
+ Hits 6136 6137 +1
Misses 12377 12377
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
EmmmaTech
reviewed
Nov 8, 2022
Lulalaby
approved these changes
Nov 8, 2022
|
Has this been tested? |
yes |
Dorukyum
approved these changes
Nov 8, 2022
Middledot
approved these changes
Nov 8, 2022
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.
Summary
Automatically use typehints to generate docs.
Information
examples, ...).
Checklist
type: ignorecomments were used, a comment is also left explaining why.