DOC: fix layout pad #25031
Closed
DOC: fix layout pad #25031
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
rcomer
reviewed
Jan 19, 2023
| @@ -76,7 +76,7 @@ def do_constrained_layout(fig, h_pad, w_pad, | |||
| Renderer to use. | |||
|
|
|||
| h_pad, w_pad : float | |||
| Padding around the axes elements in figure-normalized units. | |||
| Padding around the axes elements in inches. | |||
There was a problem hiding this comment.
I think this one was correct, because the layout engine does the normalisation before calling this function
matplotlib/lib/matplotlib/layout_engine.py
Lines 246 to 254 in be7ea76
There was a problem hiding this comment.
....oh, thats why its so confused. OK, I'll look into it more carefully.
| @@ -203,7 +203,7 @@ def __init__(self, *, h_pad=None, w_pad=None, | |||
| Parameters | |||
| ---------- | |||
| h_pad, w_pad : float | |||
| Padding around the axes elements in figure-normalized units. | |||
| Padding around the axes elements in inches. | |||
|
There is also the |
|
@rcomer So I'm confused what needs to be done here, if anything. Should I just close as already fixed? |
|
I think it’s already fixed in |
|
I think this has been wrong long enough to wait for 3.8 ;-) |
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
The layout pads in the constrained layout docs were incorrectly stated as being in figure-normalized units, whereas they are actually in inches. This was correct in most places, except where it mattered the most.
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