Skip to content

Add automodsumm_included_members option #103

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

Closed
wants to merge 1 commit into from

Conversation

lukelbd
Copy link
Contributor

@lukelbd lukelbd commented May 25, 2020

Implements item 2 from #91. This adds and documents the automodsumm_included_members option, which is used to add private methods other than __init__ and __call__ to the online documentation. This is useful when creating array-like or dict-like classes, for which it would be useful to document special class methods like __setitem__ and __getitem__.

@codecov
Copy link

codecov bot commented May 25, 2020

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.19%. Comparing base (4c8e33c) to head (8e59794).
Report is 141 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #103   +/-   ##
=======================================
  Coverage   87.19%   87.19%           
=======================================
  Files           5        5           
  Lines         695      695           
=======================================
  Hits          606      606           
  Misses         89       89           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@astrofrog
Copy link
Member

Looks good, could you rebase this, and add a test? Thanks!

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

@ConorMacBride ConorMacBride left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great! fe6154e shows how this feature could be tested.

@bsipocz
Copy link
Member

bsipocz commented Apr 19, 2023

This was opened from an org's fork to which maintainers can't push updates. Given the inactivity for the rebase and add test comment above, I'll go ahead and open a separate PR with 1) rebasing the commit from here, 2) cherry-pick and fixup the test from the commit mentioned in the comment above.

@bsipocz
Copy link
Member

bsipocz commented Apr 19, 2023

superseded by #165

@bsipocz bsipocz closed this Apr 19, 2023
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.

4 participants