Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Tweak Annotation docstring. #26079

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 5, 2023
Merged

Tweak Annotation docstring. #26079

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 24 additions & 25 deletions lib/matplotlib/text.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1745,15 +1745,15 @@ def transform(renderer) -> Transform
If *arrowprops* does not contain the key 'arrowstyle' the
allowed keys are:

========== ======================================================
Key Description
========== ======================================================
width The width of the arrow in points
headwidth The width of the base of the arrow head in points
headlength The length of the arrow head in points
shrink Fraction of total length to shrink from both ends
? Any key to :class:`matplotlib.patches.FancyArrowPatch`
========== ======================================================
========== =================================================
Key Description
========== =================================================
width The width of the arrow in points
headwidth The width of the base of the arrow head in points
headlength The length of the arrow head in points
shrink Fraction of total length to shrink from both ends
? Any `.FancyArrowPatch` property
========== =================================================

The arrow is attached to the edge of the text box, the exact
position (corners or centers) depending on where it's pointing to.
Expand All @@ -1762,23 +1762,22 @@ def transform(renderer) -> Transform

This is used if 'arrowstyle' is provided in the *arrowprops*.

Valid keys are the following `~matplotlib.patches.FancyArrowPatch`
parameters:
Valid keys are the following `.FancyArrowPatch` parameters:

=============== ==================================================
=============== ===================================
Key Description
=============== ==================================================
arrowstyle the arrow style
connectionstyle the connection style
relpos see below; default is (0.5, 0.5)
patchA default is bounding box of the text
patchB default is None
shrinkA default is 2 points
shrinkB default is 2 points
mutation_scale default is text size (in points)
mutation_aspect default is 1.
? any key for :class:`matplotlib.patches.PathPatch`
=============== ==================================================
=============== ===================================
arrowstyle The arrow style
connectionstyle The connection style
relpos See below; default is (0.5, 0.5)
patchA Default is bounding box of the text
patchB Default is None
shrinkA Default is 2 points
shrinkB Default is 2 points
mutation_scale Default is text size (in points)
mutation_aspect Default is 1
? Any `.FancyArrowPatch` property
=============== ===================================

The exact starting point position of the arrow is defined by
*relpos*. It's a tuple of relative coordinates of the text box,
Expand All @@ -1798,7 +1797,7 @@ def transform(renderer) -> Transform
the axes and *xycoords* is 'data'.

**kwargs
Additional kwargs are passed to `~matplotlib.text.Text`.
Additional kwargs are passed to `.Text`.

Returns
-------
Expand Down