@@ -1563,15 +1563,17 @@ def __init__(self, xy, r, width, angle=0.0, **kwargs):
15631563 xy : (float, float)
15641564 xy coordinates of annulus centre.
15651565 r : float or (float, float)
1566- The radius, or semi-major axes
1567- - If float: radius of the outer circle
1568- - If two floats: semi-major and -minor axes of outer
1569- ellipse
1566+ The radius, or semi-axes.
1567+ - If float: radius of the outer circle.
1568+ - If two floats: semi-major and -minor axes of outer ellipse.
15701569 width : float
1571- Width (thickness) of the annulus ring.
1572- angle: float, default=0
1573- Rotation angle in degrees (anti-clockwise). Ignored for circular
1574- annuli (ie. if *r* is a scalar).
1570+ Width (thickness) of the annular ring. The width is measured inward
1571+ from the outer ellipse so that for the inner ellipse the semi-axes
1572+ are given by `r - width`. `width` must be less than or equal to the
1573+ semi-minor axis.
1574+ angle : float, default=0
1575+ Rotation angle in degrees (anti-clockwise from the positive
1576+ x-axis). Ignored for circular annuli (ie. if *r* is a scalar).
15751577
15761578 Valid kwargs are:
15771579
@@ -1614,15 +1616,16 @@ def get_center(self):
16141616
16151617 def set_width (self , width ):
16161618 """
1617- Set the width (thickness) of the annulus ring.
1619+ Set the width (thickness) of the annulus ring. The width is measured
1620+ inwards from the outer ellipse.
16181621
16191622 Parameters
16201623 ----------
16211624 width : float
16221625 """
16231626 if min (self .a , self .b ) <= width :
16241627 raise ValueError (
1625- 'Width of annulus must be smaller than semi-minor axis' )
1628+ 'Width of annulus must be less than or equal semi-minor axis' )
16261629
16271630 self ._width = width
16281631 self ._path = None
@@ -1700,7 +1703,6 @@ def set_radii(self, r):
17001703 def get_radii (self ):
17011704 return self .a , self .b
17021705
1703- # alias
17041706 radii = property (get_radii , set_radii )
17051707
17061708 def _transform_verts (self , verts , a , b ):
0 commit comments