Document how Path.arc handles >360 degree arcs.

QuLogic · QuLogic · commit e41d033009d6 · 2017-08-07T04:14:24.000-04:00
diff --git a/lib/matplotlib/path.py b/lib/matplotlib/path.py
@@ -856,6 +856,10 @@ def arc(cls, theta1, theta2, n=None, is_wedge=False):
         Return an arc on the unit circle from angle
         *theta1* to angle *theta2* (in degrees).
 
+        *theta2* is unwrapped to produce the shortest arc within 360 degrees.
+        That is, if *theta2* > *theta1* + 360, the arc will be from *theta1* to
+        *theta2* - 360 and not a full circle plus some extra overlap.
+
         If *n* is provided, it is the number of spline segments to make.
         If *n* is not provided, the number of spline segments is
         determined based on the delta between *theta1* and *theta2*.
@@ -931,6 +935,10 @@ def wedge(cls, theta1, theta2, n=None):
         Return a wedge of the unit circle from angle
         *theta1* to angle *theta2* (in degrees).
 
+        *theta2* is unwrapped to produce the shortest wedge within 360 degrees.
+        That is, if *theta2* > *theta1* + 360, the wedge will be from *theta1*
+        to *theta2* - 360 and not a full circle plus some extra overlap.
+
         If *n* is provided, it is the number of spline segments to make.
         If *n* is not provided, the number of spline segments is
         determined based on the delta between *theta1* and *theta2*.
