Clarify behavior of the 'tight' kwarg to autoscale/autoscale_view. #13659
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
The 'tight' kwarg behaves subtly differently in autoscale and in autoscale_view (in the former, it additionally sets the margins to zero). In autoscale_view, the default of tight=True actually has no effect in the default style, which disables it via an rcParam (which, by the way, is documented with a typo in matplotlibrc.template). Try to clarify these less-than-obvious behaviors.
anntzer
commented
Mar 13, 2019
|
|
||
| If True, first set the margins to zero. Then, this argument is | ||
| forwarded to `autoscale_view` (regardless of its value); see the | ||
| description of its behavior there. |
There was a problem hiding this comment.
(It's complicated enough that I decided against duplicating the text. Note that the old version is wrong since mpl2.0.)
timhoffm
approved these changes
Mar 16, 2019
|
@timhoffm good to merge? :) |
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.
The 'tight' kwarg behaves subtly differently in autoscale and in
autoscale_view (in the former, it additionally sets the margins to
zero).
In autoscale_view, the default of tight=True actually has no effect in
the default style, which disables it via an rcParam (which, by the way,
is documented with a typo in matplotlibrc.template).
Try to clarify these less-than-obvious behaviors.
PR Summary
PR Checklist