Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add automodsumm_ignore_emptydoc global option and flags #102

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

lukelbd
Copy link
Contributor

@lukelbd lukelbd commented May 25, 2020

Implements item 1 from #91. This adds and documents the automodsumm_ignore_emptydoc flag and :ignore-emptydoc: and :no-ignore-emptydoc: options, which can be thought of as an expansion of automodsumm_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 query help(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.

@codecov
Copy link

codecov bot commented May 25, 2020

Codecov Report

Merging #102 into master will decrease coverage by 0.47%.
The diff coverage is 64.28%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #102      +/-   ##
==========================================
- Coverage   87.19%   86.72%   -0.48%     
==========================================
  Files           5        5              
  Lines         695      708      +13     
==========================================
+ Hits          606      614       +8     
- Misses         89       94       +5     
Impacted Files Coverage Δ
sphinx_automodapi/automodapi.py 89.15% <55.55%> (-1.99%) ⬇️
sphinx_automodapi/automodsumm.py 85.67% <80.00%> (-0.09%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4c8e33c...50b9e1b. Read the comment docs.

Base automatically changed from master to main March 9, 2021 20:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants