NotificationsYou must be signed in to change notification settings
Fork7.9k
Star21.3k

Clarify docs of Rectangle#17024

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

Jump to bottom

Merged

anntzer merged 1 commit intomatplotlib:masterfromtimhoffm:doc-rectangle

Apr 7, 2020

Merged

Clarify docs of Rectangle#17024

anntzer merged 1 commit intomatplotlib:masterfromtimhoffm:doc-rectangle

Apr 7, 2020

Conversation

Copy link

Member

timhoffm commentedApr 4, 2020•
edited
Loading

PR Summary

Follow up to#17008, which only went half-way, because it left the "bottom left" description in the summary sentence.

Additional improvements:

Added an ASCII image for illustration
Commented on the left/right bottom/top corner position ofxy. IMHO the "bottom left" ideais helpful to imagine the rectangle, it just has to be taken with the caution of orientations.
Also, we haveget/set_x/y/xy methods which are all describe in the "bottom left" picture. I think it's ok to leave them as is if we have that picture put into perspective.
Moved the Patch properties from section Notes to Other Parameters.
Removed explicit documentation offill because it's already documented via the Patch properties.

timhoffm force-pushed thedoc-rectangle branch from88e936b to1244ba1Compare

April 4, 2020 00:26

timhoffm added the Documentation label

Apr 4, 2020

timhoffm added this to thev3.3.0 milestone

Apr 4, 2020

QuLogic reviewed

Apr 4, 2020

View reviewed changes

Copy link

Member

QuLogic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Docs broke, but in an unrelated file, so I'm not sure why.

lib/matplotlib/patches.py Outdated

		@@ -705,8 +705,22 @@ def draw(self, renderer):

		class Rectangle(Patch):
		"""
		A rectangle with lower left at xy = (x, y) with
		specified width, height and rotation angle.
		A rectangle defined via an anchor point xy = (x, y) and its width

Copy link

Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Summary really should be one line, if possible.

timhoffm force-pushed thedoc-rectangle branch from1244ba1 tod558f47Compare

April 4, 2020 18:12

tacaswell reviewed

Apr 4, 2020

View reviewed changes

lib/matplotlib/patches.py Outdated

		%(Patch)s
		Other Parameters
		----------------
		**kwargs : `Patch` properties

Copy link

Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I think it is unhappy about this reference?

/home/circleci/project/lib/matplotlib/table.py:docstring of matplotlib.table.Cell:123: WARNING: py:obj reference target not found: Patch/home/circleci/project/lib/matplotlib/table.py:docstring of matplotlib.table.CustomCell:90: WARNING: py:obj reference target not found: Patch

but the location makes no sense...

Copy link

MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I think it is unhappy about this reference?

/home/circleci/project/lib/matplotlib/table.py:docstring of matplotlib.table.Cell:123: WARNING: py:obj reference target not found: Patch/home/circleci/project/lib/matplotlib/table.py:docstring of matplotlib.table.CustomCell:90: WARNING: py:obj reference target not found: Patch

but the location makes no sense...

Well it does make sense: Wonders of inherited docstrings.

Cell inherits from rectangle. And likely (I don‘t have code access right now) it reuses the docstring. However, Patch is not in the moduletable. The solution is to use`.Patch`. I will fix this later (or anybody can push that change).