DOC: add layout='none' option to Figure constructor #25305
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jklymak
approved these changes
Feb 23, 2023
|
I could copy the full description across to pyplot? |
|
I would, but it could be a different PR. |
531735e to
e5631d3
Compare
QuLogic
reviewed
Feb 23, 2023
lib/matplotlib/pyplot.py
Outdated
| managers can measurably slow down figure display. Defaults to *None* | ||
| (but see the documentation of the `.Figure` constructor regarding the | ||
| interaction with rcParams). | ||
| managers can measurably slow down figure display. Defaults to *None*. |
There was a problem hiding this comment.
Probably can remove the Default here as it's in the type line.
lib/matplotlib/pyplot.py
Outdated
Comment on lines
749
to
770
| - 'constrained': The constrained layout solver adjusts axes sizes | ||
| to avoid overlapping axes decorations. Can handle complex plot | ||
| layouts and colorbars, and is thus recommended. | ||
|
|
||
| See :doc:`/tutorials/intermediate/constrainedlayout_guide` | ||
| for examples. | ||
|
|
||
| - 'compressed': uses the same algorithm as 'constrained', but | ||
| removes extra space between fixed-aspect-ratio Axes. Best for | ||
| simple grids of axes. | ||
|
|
||
| - 'tight': Use the tight layout mechanism. This is a relatively | ||
| simple algorithm that adjusts the subplot parameters so that | ||
| decorations do not overlap. See `.Figure.set_tight_layout` for | ||
| further details. | ||
|
|
||
| - 'none': Do not use a layout engine. | ||
|
|
||
| - A `.LayoutEngine` instance. Builtin layout classes are | ||
| `.ConstrainedLayoutEngine` and `.TightLayoutEngine`, more easily | ||
| accessible by 'constrained' and 'tight'. Passing an instance | ||
| allows third parties to provide their own layout engine. |
There was a problem hiding this comment.
There is an extra indent on all the continuation lines of each bullet point.
e5631d3 to
6b32e29
Compare
|
Looks like the formatting still needs some work? |
jklymak
reviewed
Feb 24, 2023
| @@ -2420,11 +2420,11 @@ def __init__(self, | |||
| The use of this parameter is discouraged. Please use | |||
| ``layout='constrained'`` instead. | |||
|
|
|||
| layout : {'constrained', 'compressed', 'tight', `.LayoutEngine`, None} | |||
| layout : {'constrained', 'compressed', 'tight', 'none', `.LayoutEngine`, \ | |||
| None}, default: None | |||
There was a problem hiding this comment.
Its not your fault, but the 'constrained' bullet below has an extra indent
There was a problem hiding this comment.
Oh that's why it's in bold. I was scratching my head about that...
…actions] [skip azp]
6b32e29 to
2d3cd47
Compare
|
I think it's OK now |
jklymak
approved these changes
Feb 24, 2023
|
Agreed, thanks for cleaning up the previous breakage! |
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Feb 24, 2023
rcomer
added a commit
that referenced
this pull request
Feb 24, 2023
…305-on-v3.7.x Backport PR #25305 on branch v3.7.x (DOC: add layout='none' option to Figure constructor)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Summary
Closes #25223. Documents the
layout='none'option for creating a figure.PR Checklist
Documentation and Tests
pytestpasses)Release Notes
.. versionadded::directive in the docstring and documented indoc/users/next_whats_new/.. versionchanged::directive in the docstring and documented indoc/api/next_api_changes/next_whats_new/README.rstornext_api_changes/README.rst