Add automodsumm_included_members option#103
Closed
lukelbd wants to merge 1 commit intoastropy:mainfrom
Closed
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
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. |
Member
|
Looks good, could you rebase this, and add a test? Thanks! |
Member
ConorMacBride
left a comment
There was a problem hiding this comment.
This looks great! fe6154e shows how this feature could be tested.
Member
|
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. |
Member
|
superseded by #165 |
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
4 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 2 from #91. This adds and documents the
automodsumm_included_membersoption, 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__.