Skip to content

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

❌ Patch coverage is 64.28571% with 5 lines in your changes missing coverage. Please review.
✅ Project coverage is 86.72%. Comparing base (4c8e33c) to head (50b9e1b).
⚠️ Report is 231 commits behind head on main.

Files with missing lines Patch % Lines
sphinx_automodapi/automodapi.py 55.55% 4 Missing ⚠️
sphinx_automodapi/automodsumm.py 80.00% 1 Missing ⚠️
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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Base automatically changed from master to main March 9, 2021 20:00
@pllim
Copy link
Member

pllim commented Dec 12, 2025

Has conflict now. If you are still interested to pursue, please open new PR. Thanks and sorry!

@pllim pllim closed this Dec 12, 2025
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.

3 participants