Add autodoc_default_options to inherit docstrings#830
Merged
LucaMarconato merged 2 commits intoscverse:mainfrom Jan 15, 2025
Merged
Add autodoc_default_options to inherit docstrings#830LucaMarconato merged 2 commits intoscverse:mainfrom
LucaMarconato merged 2 commits intoscverse:mainfrom
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #830 +/- ##
=======================================
Coverage 91.72% 91.72%
=======================================
Files 46 46
Lines 7166 7166
=======================================
Hits 6573 6573
Misses 593 593 🚀 New features to boost your workflow:
|
LucaMarconato
approved these changes
Jan 15, 2025
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
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.
Closes #828
I set the following defaults for the autodoc. The first interesting thing is that
'inherited-members': Truefixes #828 because it will now show the inherited docstrings. The second thing is that'members': Truesignificantly cleans up the docs because I can remove it everywhere else.Note that I also removed
:undoc-members:, because I don't think we should show methods that are not documented (it adds a lot of unreadable sections). But feel free to add it in the defaults if you prefer to have it @LucaMarconato