Skip to content

Commit fe9c213

Browse files
committed
DOC: Document set_figure() is a low-level API
Closes matplotlib#31135.
1 parent 51fbfc4 commit fe9c213

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

lib/matplotlib/artist.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -767,6 +767,15 @@ def set_figure(self, fig):
767767
"""
768768
Set the `.Figure` or `.SubFigure` instance the artist belongs to.
769769
770+
.. warning::
771+
772+
This function should typically not be called by users.
773+
774+
This is a low-level API and only modifies the internal state of the
775+
Artist. Only modifying this is not enough and will typically lead
776+
to an inconsistent state, because the state of the figure has to
777+
be changed as well.
778+
770779
Parameters
771780
----------
772781
fig : `~matplotlib.figure.Figure` or `~matplotlib.figure.SubFigure`

0 commit comments

Comments
 (0)