Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork7.9k
DOC: Document the parameter *position* of apply_aspect() as internal#28342
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
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
Superseedsmatplotlib#23629.It is somewhat surprising that "_apply_aspect" takes anoptional position as input, which seems more functionalitythan what the name suggests.The parameter was introduced in66290aa. Generally, applyingan aspect will modify the size and position of an Axes. Thefact that position is updated anyway was used to funneladditional position information from a layout into the alreadyexisting positioning code.Deprecating and removing the parameter would be a medium compatibilityhassle. Therefore, I chose only to document the status quo and itsintention, so that users are less surprised. Seematplotlib#23629 (comment)
tacaswell approved these changesJun 26, 2024
7c86942 intomatplotlib:main 41 of 42 checks passed
Uh oh!
There was an error while loading.Please reload this page.
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull requestJun 26, 2024
…of apply_aspect() as internal
QuLogic added a commit that referenced this pull requestJun 26, 2024
…342-on-v3.9.xBackport PR#28342 on branch v3.9.x (DOC: Document the parameter *position* of apply_aspect() as internal)
Sign up for freeto 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.
Superseeds#23629.
It is somewhat surprising that "_apply_aspect" takes an optional position as input, which seems more functionality than what the name suggests.
The parameter was introduced in66290aa. Generally, applying an aspect will modify the size and position of an Axes. The fact that position is updated anyway was used to funnel additional position information from a layout into the already existing positioning code.
Deprecating and removing the parameter would be a medium compatibility hassle. Therefore, I chose only to document the status quo and its intention, so that users are less surprised. See
#23629 (comment)