Add automodsumm_ignore_emptydoc global option and flags#102
Closed
lukelbd wants to merge 2 commits intoastropy:mainfrom
Closed
Add automodsumm_ignore_emptydoc global option and flags#102lukelbd wants to merge 2 commits intoastropy:mainfrom
lukelbd wants to merge 2 commits intoastropy:mainfrom
Conversation
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #102 +/- ##
==========================================
- Coverage 87.19% 86.72% -0.48%
==========================================
Files 5 5
Lines 695 708 +13
==========================================
+ Hits 606 614 +8
- Misses 89 94 +5 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Member
|
Has conflict now. If you are still interested to pursue, please open new PR. Thanks and sorry! |
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
3 participants
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.
Implements item 1 from #91. This adds and documents the
automodsumm_ignore_emptydocflag and:ignore-emptydoc:and:no-ignore-emptydoc:options, which can be thought of as an expansion ofautomodsumm_inherited_methods,:inherited-methods:, and:no-inherited-methods:.These options are used to ignore "public" (i.e. name does not start with
_) class methods with empty__doc__attributes. This can be used to let developers override public methods or classes from external libraries, but suppress documentation of those overrides. Developers may want to leave out the docstring from an overridden public method so that when users queryhelp(cls.method), they get the original, rich documentation from the external library, and they do not have to reproduce the external library documentation in their bare-bones override function.This may be a bit niche for ProPlot but I think it's a pretty harmless addition, and it of course defaults to
False.