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
Closes#15433

PR Checklist

Has Pytest style unit tests
Code isFlake 8 compliant
New features are documented, with examples if plot related
Documentation is sphinx and numpydoc compliant
Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way

Change the description of Rectangle's xy parameter

677a57c

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. Seematplotlib#15401.In this PR, a fix is made to explain xy as starting coordinates so as to make it suitable for both casesClosesmatplotlib#15433Taken things frommatplotlib#15433.

Copy link

ContributorAuthor

SidharthBansal commentedApr 2, 2020

@timhoffm @anntzer @story645 @tacaswell kindly review and suggest changes if any. I am just trying to complete some pending PRS from which contributors left. This will help me to learn about mpl :-)
Thanks

Copy link

ContributorAuthor

SidharthBansal commentedApr 2, 2020

I am not able to add reviewers' from lefthand side topmost panel. Can anyone give me access to add reviewers if possible?
Thanks
Sidharth

Copy link

Member

QuLogic commentedApr 3, 2020

I'm not sure I agree with this change, as what constitutes the anchor point of the rectangle?

Copy link

ContributorAuthor

SidharthBansal commentedApr 3, 2020 via email

The leftmost bottommost point of the rectangle

…

On Fri, 3 Apr 2020, 6:13 am Elliott Sales de Andrade, < ***@***.***> wrote: I'm not sure I agree with this change, as what constitutes the anchor point of the rectangle? — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#17008 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AFAAEQ5YBBOBX6PQROPISCTRKUWJPANCNFSM4L23OTGQ> .

Copy link

ContributorAuthor

SidharthBansal commentedApr 3, 2020•
edited
Loading

Kindly check#15401 (comment) and#15433

Copy link

Member

timhoffm commentedApr 3, 2020•
edited
Loading

Whetherxy is really the bottom left depends on the direction of the axis and the sign ofwidth andheight.

IMHO, it's correct to call it anchor point, but this needs more context:

The rectangle extends fromxy bywidth in x-direction and byheight in y-direction.

The rectangle extends fromxy[0] toxy[0] + width and fromxy[1] toxy[1] + height.

or similar. Please find a suitable wording yourself.

Increasing readability of comments

290815d

Copy link

ContributorAuthor

SidharthBansal commentedApr 3, 2020

Done! Thanks for a detailed explanation.

story645 approved these changes

Apr 3, 2020

View reviewed changes

Copy link

ContributorAuthor

SidharthBansal commentedApr 3, 2020 via email

Thanks@story645

…

On Fri, 3 Apr 2020, 9:22 pm hannah, ***@***.***> wrote: ***@***.**** approved this pull request. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#17008 (review)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AFAAEQ235XBCCP6JT7ULBZDRKYA3PANCNFSM4L23OTGQ> .