Skip to content

DOC: drop the experimental tag constrained_layout and tight_layout#17094

Merged
QuLogic merged 2 commits into
matplotlib:masterfrom
jklymak:doc-drop-experimental-constrained
Apr 13, 2020
Merged

DOC: drop the experimental tag constrained_layout and tight_layout#17094
QuLogic merged 2 commits into
matplotlib:masterfrom
jklymak:doc-drop-experimental-constrained

Conversation

@jklymak

@jklymak jklymak commented Apr 10, 2020

Copy link
Copy Markdown
Member

PR Summary

constrained_layout was marked experimental. Its been around for a couple of years with no indication that the API will change, and no complete show-stoppers so I propose to drop the experimental tag.

Interestingly, as I grepped for "experimental" tight_layout was deemed experimental as well.

Both tutorials had useful information in the same clause as the experimental designation, so I tried to maintain that info in the rewrite.

PR Checklist

  • Has Pytest style unit tests
  • Code is Flake 8 compliant
  • New features are documented, with examples if plot related
  • Documentation is sphinx and numpydoc compliant
  • Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
  • Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way

@jklymak jklymak force-pushed the doc-drop-experimental-constrained branch from 2f4e728 to 7c8b384 Compare April 10, 2020 15:30
@jklymak jklymak added Documentation topic: geometry manager LayoutEngine, Constrained layout, Tight layout labels Apr 10, 2020
@jklymak

jklymak commented Apr 10, 2020

Copy link
Copy Markdown
Member Author

I guess this should get two approvals because it is dropping an "experimental" tag.

@tacaswell tacaswell added this to the v3.3.0 milestone Apr 10, 2020
@timhoffm

Copy link
Copy Markdown
Member

IMHO we should mention the transition to a stable feature in a what's new or API change entry.

@jklymak

jklymak commented Apr 11, 2020

Copy link
Copy Markdown
Member Author

Sure, what's-new entry added.

@QuLogic QuLogic left a comment

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.

If @jklymak thinks it's not experimental, that's good enough for me.

@QuLogic QuLogic merged commit eb0917b into matplotlib:master Apr 13, 2020
@jklymak jklymak deleted the doc-drop-experimental-constrained branch April 15, 2020 15:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation topic: geometry manager LayoutEngine, Constrained layout, Tight layout

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants