Change the description of Rectangle's xy parameter #15433
Closed
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
timhoffm
reviewed
Oct 17, 2019
| @@ -707,7 +707,7 @@ def __init__(self, xy, width, height, angle=0.0, **kwargs): | |||
| Parameters | |||
| ---------- | |||
| xy : (float, float) | |||
| The bottom and left rectangle coordinates | |||
| The starting coordinates | |||
There was a problem hiding this comment.
Maybe better "anchor coordinates"?
SidharthBansal
added a commit
to SidharthBansal/matplotlib
that referenced
this pull request
Apr 2, 2020
matplotlib.patches.Rectangle's first parameter, xy, is previously only documented for data plotting functions in which xy means left and bottom coordinates. However, in imshow(), the vertical axis's direction is inverted, and xy means left and top coordinates. See matplotlib#15401. In this PR, a fix is made to explain xy as starting coordinates so as to make it suitable for both cases Closes matplotlib#15433 Taken things from matplotlib#15433.
6 tasks
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.
matplotlib.patches.Rectangle's first parameter, xy, is previously only documented for data plotting functions in which xy means left and bottom coordinates. However, in imshow(), the vertical axis's direction is inverted, and xy means left and top coordinates. See #15401.
In this PR, a fix is made to explain xy as starting coordinates so as to make it suitable for both cases.