Skip to content

DOC: remove experimental tag from CL#21975

Merged
jklymak merged 1 commit intomatplotlib:mainfrom
jklymak:doc-CL-not-expertimental
Dec 17, 2021
Merged

DOC: remove experimental tag from CL#21975
jklymak merged 1 commit intomatplotlib:mainfrom
jklymak:doc-CL-not-expertimental

Conversation

@jklymak
Copy link
Copy Markdown
Member

@jklymak jklymak commented Dec 16, 2021

PR Summary

Constrained layout is not really experimental any more, and we probably should not break it at this point....

PR Checklist

Tests and Styling

  • Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (install flake8-docstrings and run flake8 --docstring-convention=all).

Documentation

  • New features are documented, with examples if plot related.
  • New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
  • API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).

@jklymak
Copy link
Copy Markdown
Member Author

jklymak commented Dec 16, 2021

Note I also adjusted the Figure layout docstring. I think both layout managers suffer performance constraints, just the worse ones for constrained_layout you simply wouldn't even expect anything sensible from tight_layout.

@jklymak jklymak force-pushed the doc-CL-not-expertimental branch from bd740ce to 3a4c0fb Compare December 16, 2021 12:36
@dstansby dstansby added this to the v3.6.0 milestone Dec 16, 2021
dstansby
dstansby approved these changes Dec 16, 2021
View reviewed changes
Copy link
Copy Markdown
Member

@dstansby dstansby left a comment

Choose a reason for hiding this comment

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

With an optional suggestion

Comment thread lib/matplotlib/figure.py Outdated
Comment on lines +2218 to +2219
layout managers can have significant performance penalties as
they require an extra draw and solve an inverse problem.
Copy link
Copy Markdown
Member

@dstansby dstansby Dec 16, 2021

Choose a reason for hiding this comment

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

Suggested change
layout managers can have significant performance penalties as
they require an extra draw and solve an inverse problem.
layout managers can have significant performance penalties.

For brevity, I don't think we need to explain why?

Copy link
Copy Markdown
Member

@tacaswell tacaswell Dec 16, 2021

Choose a reason for hiding this comment

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

I'm weakly in favor of brevity here as well.

Copy link
Copy Markdown
Member Author

@jklymak jklymak Dec 17, 2021

Choose a reason for hiding this comment

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

Done...

tacaswell
tacaswell approved these changes Dec 16, 2021
View reviewed changes
Copy link
Copy Markdown
Member

@tacaswell tacaswell left a comment

Choose a reason for hiding this comment

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

Same as @dstansby

@jklymak can self-merge with or without the wording change.

@jklymak jklymak force-pushed the doc-CL-not-expertimental branch from 3a4c0fb to 8cbe67e Compare December 17, 2021 07:50
@jklymak jklymak merged commit e3555f5 into matplotlib:main Dec 17, 2021
@jklymak jklymak deleted the doc-CL-not-expertimental branch December 17, 2021 08:45
@QuLogic QuLogic mentioned this pull request Sep 9, 2022
Merged
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@tacaswell tacaswell tacaswell approved these changes

@dstansby dstansby dstansby approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

v3.6.0

Development

Successfully merging this pull request may close these issues.

3 participants

@jklymak @tacaswell @dstansby