Skip to content

DOC: Some small additions to the API docs #30956

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.

Sign up for GitHub

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

Merged
timhoffm merged 1 commit into from
Jan 14, 2026
Merged

DOC: Some small additions to the API docs #30956

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions doc/api/artist_api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,7 @@ Figure and Axes

Artist.set_figure
Artist.get_figure
Artist.figure

Children
--------
Expand Down
2 changes: 2 additions & 0 deletions doc/api/axes_api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -628,6 +628,8 @@ Other
Axes.get_transformed_clip_path_and_affine
Axes.has_data
Axes.set
Axes.get_figure
Axes.figure
Axes.remove

.. autoclass:: matplotlib.axes.Axes.ArtistList
6 changes: 3 additions & 3 deletions doc/missing-references.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"<unknown>:1"
],
"matplotlib.axes._base._AxesBase": [
"doc/api/artist_api.rst:202"
"doc/api/artist_api.rst:203"
],
"matplotlib.backend_bases._Backend": [
"lib/matplotlib/backend_bases.py:docstring of matplotlib.backend_bases.ShowBase:1"
Expand All @@ -18,7 +18,7 @@
"lib/matplotlib/backends/backend_tkcairo.py:docstring of matplotlib.backends.backend_tkcairo.FigureCanvasTkCairo:1"
],
"matplotlib.image._ImageBase": [
"doc/api/artist_api.rst:202",
"doc/api/artist_api.rst:203",
"lib/matplotlib/image.py:docstring of matplotlib.image.AxesImage:1",
"lib/matplotlib/image.py:docstring of matplotlib.image.BboxImage:1",
"lib/matplotlib/image.py:docstring of matplotlib.image.FigureImage:1"
Expand Down Expand Up @@ -67,7 +67,7 @@
"lib/matplotlib/projections/geo.py:docstring of matplotlib.projections.geo.MollweideAxes.MollweideTransform:1"
],
"matplotlib.text._AnnotationBase": [
"doc/api/artist_api.rst:202",
"doc/api/artist_api.rst:203",
"lib/matplotlib/offsetbox.py:docstring of matplotlib.offsetbox.AnnotationBbox:1",
"lib/matplotlib/text.py:docstring of matplotlib.text.Annotation:1"
],
Expand Down
22 changes: 18 additions & 4 deletions lib/matplotlib/artist.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,10 +165,24 @@ def _update_set_signature_and_docstring(cls):
if prop not in Artist._PROPERTIES_EXCLUDED_FROM_SET]])
cls.set._autogenerated_signature = True

cls.set.__doc__ = (
"Set multiple properties at once.\n\n"
"Supported properties are\n\n"
+ kwdoc(cls))
cls.set.__doc__ = ("""\
Set multiple properties at once.

::
a.set(a=A, b=B, c=C)

is equivalent to ::

a.set_a(A)
a.set_b(B)
a.set_c(C)

The order of operations is not guaranteed, however most properties do not
depend on each other.

Supported properties are

""" + kwdoc(cls))

def __init__(self):
self._stale = True
Expand Down
Loading