Skip to content

Commit 846280f

Browse files
update the doc string for fancyarrowpatch to link to annotate (matplotlib#26317)
* update the doc string for fancyarrowpatch to link to annotate * Update lib/matplotlib/patches.py Co-authored-by: Elliott Sales de Andrade <[email protected]> --------- Co-authored-by: Elliott Sales de Andrade <[email protected]>
1 parent c756cbd commit 846280f

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

lib/matplotlib/patches.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4059,7 +4059,11 @@ def get_bbox(self):
40594059

40604060
class FancyArrowPatch(Patch):
40614061
"""
4062-
A fancy arrow patch. It draws an arrow using the `ArrowStyle`.
4062+
A fancy arrow patch.
4063+
4064+
It draws an arrow using the `ArrowStyle`. It is primarily used by the
4065+
`~.axes.Axes.annotate` method. For most purposes, use the annotate method for
4066+
drawing arrows.
40634067
40644068
The head and tail positions are fixed at the specified start and end points
40654069
of the arrow, but the size and shape (in display coordinates) of the arrow

0 commit comments

Comments
 (0)