DOC: correctly specify return type of figaspect
#29545
Merged
+6
−4
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
5 tasks
rcomer
reviewed
Jan 29, 2025
|
PR should be good to merge now. |
timhoffm
approved these changes
Feb 17, 2025
|
@tacaswell @timhoffm @rcomer Is there anything to be done to get this PR merged? As far as I can see, there are no more problems. |
|
This needs a second review by a core developer, unfortunately review time is scarce. |
QuLogic
approved these changes
Apr 3, 2025
|
@meeseeksdev backport to v3.10.x |
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Apr 3, 2025
QuLogic
added a commit
that referenced
this pull request
Apr 3, 2025
…545-on-v3.10.x Backport PR #29545 on branch v3.10.x (DOC: correctly specify return type of `figaspect`)
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 docstring and type hint of
plt.figaspectsuggest that it returns a tuple of floats, while in fact it returns a NumPy array. The docstring is clarified and the type hint fixed.This was one of the issues mentioned in the issue #29540. While this PR addresses the documentation it does not fix the issue.
PR checklist