René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"[Doc]: `get_figure` may return a `SubFigure`","articleBody":"### Documentation Link\n\nhttps://matplotlib.org/devdocs/api/_as_gen/matplotlib.artist.Artist.get_figure.html#matplotlib.artist.Artist.get_figure\n\n### Problem\n\nI'm not sure whether this is a documentation issue or a bug.  The docstring for `get_figure` states that it returns a `Figure`, which I think implies the parent figure.  If our artist is on a subfigure, it will return that.  Note that `SubFigure` does not inherit from `Figure`.\r\n\r\n```python\r\nIn [1]: import matplotlib.pyplot as plt\r\n\r\nIn [2]: fig = plt.figure()\r\n\r\nIn [3]: sfig = fig.subfigures()\r\n\r\nIn [4]: ax = sfig.subplots()\r\n\r\nIn [5]: ax.get_figure()\r\nOut[5]: \u003cmatplotlib.figure.SubFigure at 0x7dc0ddf4a870\u003e\r\n```\n\n### Suggested improvement\n\nEither\r\n* modify the docstring to clarify you might get the `SubFigure` (and point to how you can get the parent `Figure` if you want it)\r\nor\r\n* fix the method so it returns the parent `Figure`","author":{"url":"https://github.com/rcomer","@type":"Person","name":"rcomer"},"datePublished":"2024-05-04T11:37:47.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":8},"url":"https://github.com/28170/matplotlib/issues/28170"}