Clarify docs of Rectangle #17024
Clarify docs of Rectangle #17024
Conversation
QuLogic
left a comment
There was a problem hiding this comment.
Docs broke, but in an unrelated file, so I'm not sure why.
lib/matplotlib/patches.py
Outdated
| """ | ||
| 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.
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
left a comment
There was a problem hiding this comment.
Anyone can merge on CI green.
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.