Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: drop the experimental tag constrained_layout and tight_layout #17094

Merged
merged 2 commits into from
Apr 13, 2020

Conversation

jklymak
Copy link
Member

@jklymak jklymak commented Apr 10, 2020

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
Copy link
Member Author

jklymak commented Apr 10, 2020

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
Member

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

@jklymak
Copy link
Member Author

jklymak commented Apr 11, 2020

Sure, what's-new entry added.

Copy link
Member

@QuLogic QuLogic left a comment

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