Limit documenting special members to __call__ #20081
Merged
Conversation
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
|
Fails with only one warning:
|
tacaswell
reviewed
Apr 28, 2021
| @@ -7,7 +7,7 @@ | |||
| {% if objtype in ['class'] %} | |||
| .. auto{{ objtype }}:: {{ objname }} | |||
| :show-inheritance: | |||
| :special-members: | |||
| :special-members: __call__ | |||
There was a problem hiding this comment.
Suggested change
| :special-members: __call__ | |
| :special-members: __call__,__init__ |
There was a problem hiding this comment.
This is not great. We don't want all the __init__ in the docs (https://57666-1385122-gh.circle-artifacts.com/0/doc/build/html/search.html?q=__init__). It's information is already available in the class docstring, e.g.
51bc5e5 to
4386c2a
Compare
Closes matplotlib#20080. Follow up to matplotlib#17151.
4386c2a to
989553e
Compare
timhoffm
commented
Apr 28, 2021
| @@ -707,7 +707,7 @@ Then in any function accepting `~.Line2D` pass-through ``kwargs``, e.g., | |||
| """ | |||
|
|
|||
| Note there is a problem for `~matplotlib.artist.Artist` ``__init__`` methods, | |||
| e.g., `matplotlib.patches.Patch.__init__`, which supports ``Patch`` ``kwargs``, | |||
There was a problem hiding this comment.
We can't link __init__ as this is not an explicit entry in the docs. It's contents is folded into the class docstring.
jklymak
approved these changes
May 19, 2021
QuLogic
approved these changes
May 20, 2021
2 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Let's try and see if this works.
Closes #20080.
Follow up to #17151.