Skip to content

DOC: Mark subfigures as no longer provisional - #28849

Merged
rcomer merged 1 commit into
matplotlib:mainfrom
QuLogic:stable-subfigure
Sep 21, 2024
Merged

rcomer merged 1 commit into
matplotlib:mainfrom
QuLogic:stable-subfigure

Conversation

@QuLogic

@QuLogic QuLogic commented Sep 20, 2024

Copy link
Copy Markdown
Member

PR summary

Fixes #25947

PR checklist

@QuLogic QuLogic added this to the v3.10.0 milestone Sep 20, 2024
@github-actions github-actions Bot added the Documentation: examples files in galleries/examples label Sep 20, 2024
Comment on lines +4 to +5
The API on `.Figure.subfigures` and `.SubFigure` are now considered stable and
will change under Matplotlib's normal deprecation process.

@timhoffm timhoffm Sep 20, 2024 •

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.

Suggested change
The API on `.Figure.subfigures` and `.SubFigure` are now considered stable and
will change under Matplotlib's normal deprecation process.
The API on `.Figure.subfigures` and `.SubFigure` are now considered stable.

I would leave that out. It confuses more than it helps. What people read from this is "The API ... will change". What we want to communicate is that the API does not change (and if there should arise a need for change, it will be announced beforehand and include a migration path). But that's just the standard way of working in the library and does not need explicit mentioning.

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.

@rcomer
rcomer merged commit 548fdcb into matplotlib:main Sep 21, 2024
@QuLogic
QuLogic deleted the stable-subfigure branch September 21, 2024 07:31
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.

[Doc]: Subfigures still marked as provisional

3 participants