Skip to content

Commit fc350ea

Browse files
authored
Merge pull request matplotlib#26079 from anntzer/ad
Tweak Annotation docstring.
2 parents 4e420ca + 9d175b7 commit fc350ea

File tree

1 file changed

+24
-25
lines changed

1 file changed

+24
-25
lines changed

lib/matplotlib/text.py

Lines changed: 24 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1745,15 +1745,15 @@ def transform(renderer) -> Transform
17451745
If *arrowprops* does not contain the key 'arrowstyle' the
17461746
allowed keys are:
17471747
1748-
========== ======================================================
1749-
Key Description
1750-
========== ======================================================
1751-
width The width of the arrow in points
1752-
headwidth The width of the base of the arrow head in points
1753-
headlength The length of the arrow head in points
1754-
shrink Fraction of total length to shrink from both ends
1755-
? Any key to :class:`matplotlib.patches.FancyArrowPatch`
1756-
========== ======================================================
1748+
========== =================================================
1749+
Key Description
1750+
========== =================================================
1751+
width The width of the arrow in points
1752+
headwidth The width of the base of the arrow head in points
1753+
headlength The length of the arrow head in points
1754+
shrink Fraction of total length to shrink from both ends
1755+
? Any `.FancyArrowPatch` property
1756+
========== =================================================
17571757
17581758
The arrow is attached to the edge of the text box, the exact
17591759
position (corners or centers) depending on where it's pointing to.
@@ -1762,23 +1762,22 @@ def transform(renderer) -> Transform
17621762
17631763
This is used if 'arrowstyle' is provided in the *arrowprops*.
17641764
1765-
Valid keys are the following `~matplotlib.patches.FancyArrowPatch`
1766-
parameters:
1765+
Valid keys are the following `.FancyArrowPatch` parameters:
17671766
1768-
=============== ==================================================
1767+
=============== ===================================
17691768
Key Description
1770-
=============== ==================================================
1771-
arrowstyle the arrow style
1772-
connectionstyle the connection style
1773-
relpos see below; default is (0.5, 0.5)
1774-
patchA default is bounding box of the text
1775-
patchB default is None
1776-
shrinkA default is 2 points
1777-
shrinkB default is 2 points
1778-
mutation_scale default is text size (in points)
1779-
mutation_aspect default is 1.
1780-
? any key for :class:`matplotlib.patches.PathPatch`
1781-
=============== ==================================================
1769+
=============== ===================================
1770+
arrowstyle The arrow style
1771+
connectionstyle The connection style
1772+
relpos See below; default is (0.5, 0.5)
1773+
patchA Default is bounding box of the text
1774+
patchB Default is None
1775+
shrinkA Default is 2 points
1776+
shrinkB Default is 2 points
1777+
mutation_scale Default is text size (in points)
1778+
mutation_aspect Default is 1
1779+
? Any `.FancyArrowPatch` property
1780+
=============== ===================================
17821781
17831782
The exact starting point position of the arrow is defined by
17841783
*relpos*. It's a tuple of relative coordinates of the text box,
@@ -1798,7 +1797,7 @@ def transform(renderer) -> Transform
17981797
the axes and *xycoords* is 'data'.
17991798
18001799
**kwargs
1801-
Additional kwargs are passed to `~matplotlib.text.Text`.
1800+
Additional kwargs are passed to `.Text`.
18021801
18031802
Returns
18041803
-------

0 commit comments

Comments
 (0)