Clarify docs of Rectangle #17024
Merged
Clarify docs of Rectangle #17024
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
QuLogic
reviewed
Apr 4, 2020
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* | |||
There was a problem hiding this comment.
Summary really should be one line, if possible.
tacaswell
reviewed
Apr 4, 2020
lib/matplotlib/patches.py
Outdated
| %(Patch)s | ||
| Other Parameters | ||
| ---------------- | ||
| **kwargs : `Patch` properties |
There was a problem hiding this comment.
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...
There was a problem hiding this comment.
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: Patchbut 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 module table. The solution is to use `.Patch`. I will fix this later (or anybody can push that change).
|
I am enthusiastically 👍 on this. |
tacaswell
approved these changes
Apr 4, 2020
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
Follow up to #17008, which only went half-way, because it left the "bottom left" description in the summary sentence.
Additional improvements:
Also, we have
get/set_x/y/xymethods 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.