Skip to content

Commit 663f70f

Browse files
committed
Fix formatting/linking problems with plt.annotate
1 parent 655b078 commit 663f70f

File tree

2 files changed

+24
-23
lines changed

2 files changed

+24
-23
lines changed

Diff for: lib/matplotlib/axes/_axes.py

+7-6
Original file line numberDiff line numberDiff line change
@@ -624,19 +624,20 @@ def annotate(self, *args, **kwargs):
624624
Default is None.
625625
626626
arrowprops : `matplotlib.lines.Line2D` properties, optional
627-
Dictionnary of line properties for the arrow that connects the
628-
annotation to the point. If the dictionnary has a key
629-
`arrowstyle`, a `FancyArrowPatch` instance is created and drawn.
630-
See `matplotlib.text.Annotation` for more details on valid
627+
Dictionary of line properties for the arrow that connects
628+
the annotation to the point. If the dictionnary has a key
629+
`arrowstyle`, a `~matplotlib.patches.FancyArrowPatch`
630+
instance is created and drawn. See
631+
`matplotlib.text.Annotation` for more details on valid
631632
options. Default is None.
632633
633634
Returns
634635
-------
635636
a : `~matplotlib.text.Annotation`
636637
637638
638-
Other parameters
639-
-----------------
639+
Notes
640+
-----
640641
641642
%(Annotation)s
642643

Diff for: lib/matplotlib/text.py

+17-17
Original file line numberDiff line numberDiff line change
@@ -1662,6 +1662,10 @@ class Annotation(Text, _AnnotationBase):
16621662
in the figure, such as :class:`~matplotlib.figure.Figure`,
16631663
:class:`~matplotlib.axes.Axes`,
16641664
:class:`~matplotlib.patches.Rectangle`, etc., easier.
1665+
1666+
Annotate the *x*, *y* point *xy* with text *s* at *x*, *y*
1667+
location *xytext*. (If *xytext* = *None*, defaults to *xy*,
1668+
and if *textcoords* = *None*, defaults to *xycoords*).
16651669
"""
16661670
def __str__(self):
16671671
return "Annotation(%g,%g,%s)" % (self.xy[0],
@@ -1677,18 +1681,15 @@ def __init__(self, s, xy,
16771681
annotation_clip=None,
16781682
**kwargs):
16791683
"""
1680-
Annotate the *x*, *y* point *xy* with text *s* at *x*, *y*
1681-
location *xytext*. (If *xytext* = *None*, defaults to *xy*,
1682-
and if *textcoords* = *None*, defaults to *xycoords*).
1683-
16841684
*arrowprops*, if not *None*, is a dictionary of line properties
16851685
(see :class:`matplotlib.lines.Line2D`) for the arrow that connects
16861686
annotation to the point.
16871687
1688-
If the dictionary has a key *arrowstyle*, a FancyArrowPatch
1689-
instance is created with the given dictionary and is
1690-
drawn. Otherwise, a YAArow patch instance is created and
1691-
drawn. Valid keys for YAArow are
1688+
If the dictionary has a key *arrowstyle*, a
1689+
`~matplotlib.patches.FancyArrowPatch` instance is created with
1690+
the given dictionary and is drawn. Otherwise, a
1691+
`~matplotlib.patches.YAArrow` patch instance is created and
1692+
drawn. Valid keys for `~matplotlib.patches.YAArrow` are:
16921693
16931694
16941695
========= ===========================================================
@@ -1707,7 +1708,7 @@ def __init__(self, s, xy,
17071708
========= ===========================================================
17081709
17091710
1710-
Valid keys for FancyArrowPatch are
1711+
Valid keys for `~matplotlib.patches.FancyArrowPatch` are:
17111712
17121713
17131714
=============== ======================================================
@@ -1727,7 +1728,8 @@ def __init__(self, s, xy,
17271728
17281729
17291730
*xycoords* and *textcoords* are strings that indicate the
1730-
coordinates of *xy* and *xytext*.
1731+
coordinates of *xy* and *xytext*, and may be one of the
1732+
following values:
17311733
17321734
================= ===================================================
17331735
Property Description
@@ -1763,18 +1765,16 @@ def __init__(self, s, xy,
17631765
:class:`~matplotlib.artist.Artist`. See
17641766
:ref:`plotting-guide-annotation` for more details.
17651767
1766-
17671768
The *annotation_clip* attribute controls the visibility of the
1768-
annotation when it goes outside the axes area. If True, the
1769+
annotation when it goes outside the axes area. If `True`, the
17691770
annotation will only be drawn when the *xy* is inside the
1770-
axes. If False, the annotation will always be drawn regardless
1771-
of its position. The default is *None*, which behave as True
1772-
only if *xycoords* is"data".
1771+
axes. If `False`, the annotation will always be drawn
1772+
regardless of its position. The default is `None`, which
1773+
behave as `True` only if *xycoords* is "data".
17731774
1774-
Additional kwargs are Text properties:
1775+
Additional kwargs are `~matplotlib.text.Text` properties:
17751776
17761777
%(Text)s
1777-
17781778
"""
17791779

17801780
_AnnotationBase.__init__(self,

0 commit comments

Comments
 (0)