Document the 'resolution' kwarg to polar plots.

mdboom · mdboom · commit 703b0e338407 · 2009-01-29T21:36:54.000Z
svn path=/branches/v0_98_5_maint/; revision=6854
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,3 +1,6 @@
+2009-01-29 Document 'resolution' kwarg for polar plots.  Support it
+           when using pyplot.polar, not just Figure.add_axes. - MGD
+
 2009-01-26 Make curves and NaNs play nice together - MGD
 
 2009-01-19 Fix bug in quiver argument handling. - EF
diff --git a/lib/matplotlib/projections/polar.py b/lib/matplotlib/projections/polar.py
@@ -182,10 +182,18 @@ def view_limits(self, vmin, vmax):
     def __init__(self, *args, **kwargs):
         """
         Create a new Polar Axes for a polar plot.
+
+        The following optional kwargs are supported:
+
+          - *resolution*: The number of points of interpolation between
+            each pair of data points.  Set to 1 to disable
+            interpolation.
         """
 
         self._rpad = 0.05
-        self.resolution = kwargs.pop('resolution', self.RESOLUTION)
+        self.resolution = kwargs.pop('resolution', None)
+        if self.resolution is None:
+            self.resolution = self.RESOLUTION
         Axes.__init__(self, *args, **kwargs)
         self.set_aspect('equal', adjustable='box', anchor='C')
         self.cla()
diff --git a/lib/matplotlib/pyplot.py b/lib/matplotlib/pyplot.py
@@ -1406,8 +1406,13 @@ def polar(*args, **kwargs):
 
     Make a polar plot.  Multiple *theta*, *r* arguments are supported,
     with format strings, as in :func:`~matplotlib.pyplot.plot`.
+
+    An optional kwarg *resolution* sets the number of vertices to
+    interpolate between each pair of points.  Set to 1 to disable
+    interpolation.
     """
-    ax = gca(polar=True)
+    resolution = kwargs.pop('resolution', None)
+    ax = gca(polar=True, resolution=resolution)
     ret = ax.plot(*args, **kwargs)
     draw_if_interactive()
     return ret
