Improve documentation of text module #16004
Conversation
lib/matplotlib/text.py
Outdated
| Draw the :class:`Annotation` object to the given *renderer*. | ||
| """ | ||
|
|
||
| """Draw the `Annotation` object to the given *renderer*.""" |
There was a problem hiding this comment.
The inherited one would be "Draw the Text object to the given renderer.", which is slightly confusing. Right now, I can't think of a generic version that would suit both. So would leave this in.
There was a problem hiding this comment.
Text.draw could also be inherited, I guess?
There was a problem hiding this comment.
The base is Artist.draw, which has a technical comment on subclassing. It's probably possible to find a generic way of expressing that, so that it's appropriate in all Artist subclasses. But for now, I think leaving the explicit docstrings is the simplest solution.
There was a problem hiding this comment.
I guess I'll fix the base docstring later.
5ef6f69 to
9a483f2
Compare
| """ | ||
| return self._horizontalalignment | ||
|
|
||
| def get_unitless_position(self): | ||
| "Return the unitless position of the text as a tuple (*x*, *y*)" | ||
| """Return the (x, y) unitless position of the text.""" |
There was a problem hiding this comment.
perhaps be consistent between
x, y
(x, y)
(*x*, *y*)
*(x, y)*
?
all of them occur right now in this patch.
There was a problem hiding this comment.
Gone with the simple (x, y).
PR Summary
The usual standardization of docstrings.