Clarify Annotation arrowprops docs #21743
Conversation
0d209c7 to
bb747df
Compare
| ``'arrowstyle'`` are: | ||
|
|
||
| ============ ============================================= | ||
| Name Attrs |
There was a problem hiding this comment.
Did you drop this table on purpose?
There was a problem hiding this comment.
Yes. The table is incomplete: Not all styles are listed, not all parameters to the styles are listed. I think it's excessive to try and replicate all this information. Instead I hope that the sentence "Valid keys are the following ~matplotlib.patches.FancyArrowPatch parameters:" is enough context to it's subsequent table, which also lists arrowstyle. The FancyArrowPatch docs lists all styles and related parameters in detail.
lib/matplotlib/text.py
Outdated
| positions *xy* and *xytext*. Defaults to None, i.e. no arrow is | ||
| drawn. | ||
|
|
||
| For historical reasons there are two different ways of usage, that |
There was a problem hiding this comment.
| For historical reasons there are two different ways of usage, that | |
| For historical reasons, there are two different usages that |
There was a problem hiding this comment.
I'm not sure that's what I want to say. IMHO there is only one usage, namely specifying the type of arrows, but there are two ways to do it. I was considering using "two different APIs" but thought that is too technical.
There was a problem hiding this comment.
Maybe:
| For historical reasons there are two different ways of usage, that | |
| For historical reasons there are two different ways to specify arrows, "simple" and "fancy": |
and maybe drop the next clause?
There was a problem hiding this comment.
Followed @jklymak suggestion.
bb747df to
004e15e
Compare
…743-on-v3.5.x Backport PR #21743 on branch v3.5.x (Clarify Annotation arrowprops docs)
…743-on-v3.5.0-doc Backport PR #21743 on branch v3.5.0-doc (Clarify Annotation arrowprops docs)
Closes #21733.