Skip to content

Add note that subfigure is still provisional to docstring - #25954

Merged
QuLogic merged 1 commit into
matplotlib:mainfrom
timhoffm:subfigure-provisional
May 29, 2023
Merged

QuLogic merged 1 commit into
matplotlib:mainfrom
timhoffm:subfigure-provisional

Conversation

@timhoffm

Copy link
Copy Markdown
Member

Assuming we still leave is provisional in 3.8 per #25947 (comment)

This matches the notes at https://matplotlib.org/stable/gallery/subplots_axes_and_figures/subfigures.html#figure-subfigures

@timhoffm timhoffm added this to the v3.7.2 milestone May 23, 2023
Comment thread lib/matplotlib/figure.py Outdated
See :doc:`/gallery/subplots_axes_and_figures/subfigures`.

.. note::
``subfigure`` is new in v3.4, and the API is still provisional.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be subfigures? (As in the method name?)

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is this?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've just copied from https://matplotlib.org/stable/gallery/subplots_axes_and_figures/subfigures.html#figure-subfigures

Likely it's intended to be broader than just the single method, e.g.

The subfigure concept is new in v3.4, ...

Possibly we should rewrite both notes that way, and also add it to https://matplotlib.org/stable/api/figure_api.html#matplotlib.figure.SubFigure I will follow up with a PR later.

@timhoffm
timhoffm marked this pull request as draft May 23, 2023 14:17
@timhoffm
timhoffm force-pushed the subfigure-provisional branch from 0e96cbc to aaeda87 Compare May 28, 2023 23:27
@timhoffm
timhoffm marked this pull request as ready for review May 28, 2023 23:27
@QuLogic
QuLogic merged commit 3d3a1af into matplotlib:main May 29, 2023
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request May 29, 2023
@timhoffm
timhoffm deleted the subfigure-provisional branch May 29, 2023 20:23
rcomer added a commit that referenced this pull request May 29, 2023
…954-on-v3.7.x

Backport PR #25954 on branch v3.7.x (Add note that subfigure is still provisional to docstring)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants