Skip to content

Commit 6768ef8

Browse files
authored
Merge pull request #20081 from timhoffm/doc-special-members
Limit documenting special members to __call__
2 parents fa3c4fe + 989553e commit 6768ef8

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

doc/_templates/autosummary.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
{% if objtype in ['class'] %}
88
.. auto{{ objtype }}:: {{ objname }}
99
:show-inheritance:
10-
:special-members:
10+
:special-members: __call__
1111
1212
{% else %}
1313
.. auto{{ objtype }}:: {{ objname }}

doc/devel/documenting_mpl.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -707,7 +707,7 @@ Then in any function accepting `~.Line2D` pass-through ``kwargs``, e.g.,
707707
"""
708708
709709
Note there is a problem for `~matplotlib.artist.Artist` ``__init__`` methods,
710-
e.g., `matplotlib.patches.Patch.__init__`, which supports ``Patch`` ``kwargs``,
710+
e.g., `matplotlib.patches.Patch`, which supports ``Patch`` ``kwargs``,
711711
since the artist inspector cannot work until the class is fully defined and
712712
we can't modify the ``Patch.__init__.__doc__`` docstring outside the class
713713
definition. There are some some manual hacks in this case, violating the

0 commit comments

Comments
 (0)