This repository has been archived by the owner on Dec 20, 2024. It is now read-only.
DOC: Add __init__ documentation to class documentation
#263
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
Add `__init__` documentation to class documentation: - Add a function to the documentation configuration file that processes the signatures and adds the `__init__` method signature to the class signatures. - Make the class documentation contain the documentation from both the class and the `__ini__` method setting the `autoclass_content` option to `both`. Remove the short description of the `__init__` methods so that the class documentation reads seamlessly.
jhlegarreta
force-pushed
the
DocumentClassWithInit
branch
from
29c1eb9 to
5d10d90
Compare
|
Local check:
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #263 +/- ##
=======================================
Coverage 66.24% 66.24%
=======================================
Files 19 19
Lines 942 942
Branches 119 119
=======================================
Hits 624 624
Misses 274 274
Partials 44 44 ☔ View full report in Codecov by Sentry. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Add
__init__documentation to class documentation:__init__method signature to the class signatures.__ini__method setting theautoclass_contentoption toboth.Remove the short description of the
__init__methods so that the class documentation reads seamlessly.