Clarify FigureBase.tight_bbox as different from all other artists. #21286
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
reviewed
Oct 5, 2021
| @@ -1598,6 +1598,9 @@ def get_tightbbox(self, renderer, bbox_extra_artists=None): | |||
| """ | |||
| Return a (tight) bounding box of the figure in inches. | |||
|
|
|||
There was a problem hiding this comment.
The previous sentence says the box will be in inches. Maybe combine these the old and new sentences?
It explicitly scales the union of child tightbboxes by 1/dpi, i.e. converts from pixels to inches. Perhaps that's not the most elegant design, but let's make that behavior clear.
jklymak
approved these changes
Oct 5, 2021
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Oct 7, 2021
…ent from all other artists.
QuLogic
added a commit
that referenced
this pull request
Oct 7, 2021
…286-on-v3.5.x Backport PR #21286 on branch v3.5.x (Clarify FigureBase.tight_bbox as different from all other artists.)
tacaswell
added a commit
to tacaswell/matplotlib
that referenced
this pull request
Oct 12, 2021
DOC: Clarify FigureBase.tight_bbox as different from all other artists.
tacaswell
added a commit
that referenced
this pull request
Oct 20, 2021
DOC: Clarify FigureBase.tight_bbox as different from all other artists.
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.
It explicitly scales the union of child tightbboxes by 1/dpi, i.e.
converts from pixels to inches. Perhaps that's not the most elegant
design, but let's make that behavior clear.
PR Summary
PR Checklist
pytestpasses).flake8on changed files to check).flake8-docstringsand runflake8 --docstring-convention=all).doc/users/next_whats_new/(follow instructions in README.rst there).doc/api/next_api_changes/(follow instructions in README.rst there).