Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit 36ec04f

Browse filesBrowse files
QuLogicdstansby
QuLogic
authored and
dstansby
committed
Merge pull request matplotlib#8343 from patniharshit/arrowStyleDocstring
Make ArrowStyle docstrings numpydoc compatible
1 parent c8b4db8 commit 36ec04f
Copy full SHA for 36ec04f

File tree

Expand file treeCollapse file tree

1 file changed

+100
-84
lines changed
Filter options
Expand file treeCollapse file tree

1 file changed

+100
-84
lines changed

‎lib/matplotlib/patches.py

Copy file name to clipboardExpand all lines: lib/matplotlib/patches.py
+100-84Lines changed: 100 additions & 84 deletions
Original file line numberDiff line numberDiff line change
@@ -3437,11 +3437,13 @@ class CurveA(_Curve):
34373437

34383438
def __init__(self, head_length=.4, head_width=.2):
34393439
"""
3440-
*head_length*
3441-
length of the arrow head
3440+
Parameters
3441+
----------
3442+
head_length : float, optional, default : 0.4
3443+
Length of the arrow head
34423444
3443-
*head_width*
3444-
width of the arrow head
3445+
head_width : float, optional, default : 0.2
3446+
Width of the arrow head
34453447
"""
34463448

34473449
super(ArrowStyle.CurveA, self).__init__(
@@ -3457,11 +3459,13 @@ class CurveB(_Curve):
34573459

34583460
def __init__(self, head_length=.4, head_width=.2):
34593461
"""
3460-
*head_length*
3461-
length of the arrow head
3462+
Parameters
3463+
----------
3464+
head_length : float, optional, default : 0.4
3465+
Length of the arrow head
34623466
3463-
*head_width*
3464-
width of the arrow head
3467+
head_width : float, optional, default : 0.2
3468+
Width of the arrow head
34653469
"""
34663470

34673471
super(ArrowStyle.CurveB, self).__init__(
@@ -3477,11 +3481,13 @@ class CurveAB(_Curve):
34773481

34783482
def __init__(self, head_length=.4, head_width=.2):
34793483
"""
3480-
*head_length*
3481-
length of the arrow head
3484+
Parameters
3485+
----------
3486+
head_length : float, optional, default : 0.4
3487+
Length of the arrow head
34823488
3483-
*head_width*
3484-
width of the arrow head
3489+
head_width : float, optional, default : 0.2
3490+
Width of the arrow head
34853491
"""
34863492

34873493
super(ArrowStyle.CurveAB, self).__init__(
@@ -3497,11 +3503,13 @@ class CurveFilledA(_Curve):
34973503

34983504
def __init__(self, head_length=.4, head_width=.2):
34993505
"""
3500-
*head_length*
3501-
length of the arrow head
3506+
Parameters
3507+
----------
3508+
head_length : float, optional, default : 0.4
3509+
Length of the arrow head
35023510
3503-
*head_width*
3504-
width of the arrow head
3511+
head_width : float, optional, default : 0.2
3512+
Width of the arrow head
35053513
"""
35063514

35073515
super(ArrowStyle.CurveFilledA, self).__init__(
@@ -3518,11 +3526,13 @@ class CurveFilledB(_Curve):
35183526

35193527
def __init__(self, head_length=.4, head_width=.2):
35203528
"""
3521-
*head_length*
3522-
length of the arrow head
3529+
Parameters
3530+
----------
3531+
head_length : float, optional, default : 0.4
3532+
Length of the arrow head
35233533
3524-
*head_width*
3525-
width of the arrow head
3534+
head_width : float, optional, default : 0.2
3535+
Width of the arrow head
35263536
"""
35273537

35283538
super(ArrowStyle.CurveFilledB, self).__init__(
@@ -3534,17 +3544,18 @@ def __init__(self, head_length=.4, head_width=.2):
35343544

35353545
class CurveFilledAB(_Curve):
35363546
"""
3537-
An arrow with filled triangle heads both at the begin and the end
3538-
point.
3547+
An arrow with filled triangle heads at both ends.
35393548
"""
35403549

35413550
def __init__(self, head_length=.4, head_width=.2):
35423551
"""
3543-
*head_length*
3544-
length of the arrow head
3552+
Parameters
3553+
----------
3554+
head_length : float, optional, default : 0.4
3555+
Length of the arrow head
35453556
3546-
*head_width*
3547-
width of the arrow head
3557+
head_width : float, optional, default : 0.2
3558+
Width of the arrow head
35483559
"""
35493560

35503561
super(ArrowStyle.CurveFilledAB, self).__init__(
@@ -3633,30 +3644,32 @@ def transmute(self, path, mutation_size, linewidth):
36333644

36343645
class BracketAB(_Bracket):
36353646
"""
3636-
An arrow with a bracket(]) at both ends.
3647+
An arrow with a bracket(]) at both ends.
36373648
"""
36383649

36393650
def __init__(self,
36403651
widthA=1., lengthA=0.2, angleA=None,
36413652
widthB=1., lengthB=0.2, angleB=None):
36423653
"""
3643-
*widthA*
3644-
width of the bracket
3654+
Parameters
3655+
----------
3656+
widthA : float, optional, default : 1.0
3657+
Width of the bracket
36453658
3646-
*lengthA*
3647-
length of the bracket
3659+
lengthA : float, optional, default : 0.2
3660+
Length of the bracket
36483661
3649-
*angleA*
3650-
angle between the bracket and the line
3662+
angleA : float, optional, default : None
3663+
Angle between the bracket and the line
36513664
3652-
*widthB*
3653-
width of the bracket
3665+
widthB : float, optional, default : 1.0
3666+
Width of the bracket
36543667
3655-
*lengthB*
3656-
length of the bracket
3668+
lengthB : float, optional, default : 0.2
3669+
Length of the bracket
36573670
3658-
*angleB*
3659-
angle between the bracket and the line
3671+
angleB : float, optional, default : None
3672+
Angle between the bracket and the line
36603673
"""
36613674

36623675
super(ArrowStyle.BracketAB, self).__init__(
@@ -3673,14 +3686,16 @@ class BracketA(_Bracket):
36733686

36743687
def __init__(self, widthA=1., lengthA=0.2, angleA=None):
36753688
"""
3676-
*widthA*
3677-
width of the bracket
3689+
Parameters
3690+
----------
3691+
widthA : float, optional, default : 1.0
3692+
Width of the bracket
36783693
3679-
*lengthA*
3680-
length of the bracket
3694+
lengthA : float, optional, default : 0.2
3695+
Length of the bracket
36813696
3682-
*angleA*
3683-
angle between the bracket and the line
3697+
angleA : float, optional, default : None
3698+
Angle between the bracket and the line
36843699
"""
36853700

36863701
super(ArrowStyle.BracketA, self).__init__(True, None,
@@ -3697,14 +3712,16 @@ class BracketB(_Bracket):
36973712

36983713
def __init__(self, widthB=1., lengthB=0.2, angleB=None):
36993714
"""
3700-
*widthB*
3701-
width of the bracket
3715+
Parameters
3716+
----------
3717+
widthB : float, optional, default : 1.0
3718+
Width of the bracket
37023719
3703-
*lengthB*
3704-
length of the bracket
3720+
lengthB : float, optional, default : 0.2
3721+
Length of the bracket
37053722
3706-
*angleB*
3707-
angle between the bracket and the line
3723+
angleB : float, optional, default : None
3724+
Angle between the bracket and the line
37083725
"""
37093726

37103727
super(ArrowStyle.BracketB, self).__init__(None, True,
@@ -3723,23 +3740,19 @@ def __init__(self,
37233740
widthA=1., angleA=None,
37243741
widthB=1., angleB=None):
37253742
"""
3726-
*widthA*
3727-
width of the bracket
3728-
3729-
*lengthA*
3730-
length of the bracket
3731-
3732-
*angleA*
3733-
angle between the bracket and the line
3743+
Parameters
3744+
----------
3745+
widthA : float, optional, default : 1.0
3746+
Width of the bracket
37343747
3735-
*widthB*
3736-
width of the bracket
3748+
angleA : float, optional, default : None
3749+
Angle between the bracket and the line
37373750
3738-
*lengthB*
3739-
length of the bracket
3751+
widthB : float, optional, default : 1.0
3752+
Width of the bracket
37403753
3741-
*angleB*
3742-
angle between the bracket and the line
3754+
angleB : float, optional, default : None
3755+
Angle between the bracket and the line
37433756
"""
37443757

37453758
super(ArrowStyle.BarAB, self).__init__(
@@ -3755,15 +3768,16 @@ class Simple(_Base):
37553768

37563769
def __init__(self, head_length=.5, head_width=.5, tail_width=.2):
37573770
"""
3758-
*head_length*
3759-
length of the arrow head
3760-
3761-
*head_with*
3762-
width of the arrow head
3771+
Parameters
3772+
----------
3773+
head_length : float, optional, default : 0.5
3774+
Length of the arrow head
37633775
3764-
*tail_width*
3765-
width of the arrow tail
3776+
head_width : float, optional, default : 0.5
3777+
Width of the arrow head
37663778
3779+
tail_width : float, optional, default : 0.2
3780+
Width of the arrow tail
37673781
"""
37683782

37693783
self.head_length, self.head_width, self.tail_width = \
@@ -3841,15 +3855,16 @@ class Fancy(_Base):
38413855

38423856
def __init__(self, head_length=.4, head_width=.4, tail_width=.4):
38433857
"""
3844-
*head_length*
3845-
length of the arrow head
3846-
3847-
*head_with*
3848-
width of the arrow head
3858+
Parameters
3859+
----------
3860+
head_length : float, optional, default : 0.4
3861+
Length of the arrow head
38493862
3850-
*tail_width*
3851-
width of the arrow tail
3863+
head_width : float, optional, default : 0.4
3864+
Width of the arrow head
38523865
3866+
tail_width : float, optional, default : 0.4
3867+
Width of the arrow tail
38533868
"""
38543869

38553870
self.head_length, self.head_width, self.tail_width = \
@@ -3941,16 +3956,17 @@ class Wedge(_Base):
39413956
Wedge(?) shape. Only works with a quadratic bezier curve. The
39423957
begin point has a width of the tail_width and the end point has a
39433958
width of 0. At the middle, the width is shrink_factor*tail_width.
3944-
39453959
"""
39463960

39473961
def __init__(self, tail_width=.3, shrink_factor=0.5):
39483962
"""
3949-
*tail_width*
3950-
width of the tail
3963+
Parameters
3964+
----------
3965+
tail_width : float, optional, default : 0.3
3966+
Width of the tail
39513967
3952-
*shrink_factor*
3953-
fraction of the arrow width at the middle point
3968+
shrink_factor : float, optional, default : 0.5
3969+
Fraction of the arrow width at the middle point
39543970
"""
39553971

39563972
self.tail_width = tail_width

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.