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

Skip to content

Commit 18ca812

Browse files
committed
add sphinx markup to documentation
modified: lib/matplotlib/patches.py
1 parent 6e3a8bb commit 18ca812

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

lib/matplotlib/patches.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -920,30 +920,30 @@ def __init__(self, x, y, dx, dy, width=0.001, length_includes_head=False, \
920920
head_starts_at_zero=False,**kwargs):
921921
"""
922922
Constructor arguments
923-
width: float (default: 0.001)
923+
*width*: float (default: 0.001)
924924
width of full arrow tail
925925
926-
length_includes_head: [True | False] (default: False)
926+
*length_includes_head*: [True | False] (default: False)
927927
True if head is to be counted in calculating the length.
928928
929-
head_width: float or None (default: 3*width)
929+
*head_width*: float or None (default: 3*width)
930930
total width of the full arrow head
931931
932-
head_length: float or None (default: 1.5 * head_width)
932+
*head_length*: float or None (default: 1.5 * head_width)
933933
length of arrow head
934934
935-
shape: ['full', 'left', 'right'] (default: 'full')
935+
*shape*: ['full', 'left', 'right'] (default: 'full')
936936
draw the left-half, right-half, or full arrow
937937
938-
overhang: float (default: 0)
938+
*overhang*: float (default: 0)
939939
fraction that the arrow is swept back (0 overhang means
940940
triangular shape). Can be negative or greater than one.
941941
942-
head_starts_at_zero: [True | False] (default: False)
942+
*head_starts_at_zero*: [True | False] (default: False)
943943
if True, the head starts being drawn at coordinate 0
944944
instead of ending at coordinate 0.
945945
946-
Other valid kwargs (inherited from Patch) are:
946+
Other valid kwargs (inherited from :class:`Patch`) are:
947947
%(Patch)s
948948
949949
"""

0 commit comments

Comments
 (0)