add docstring and ax as parameter

matplotlib · MC-Escherichia · Sep 27, 2014 · Sep 27, 2014 · Sep 27, 2014 · Sep 27, 2014
commit a7b8dfff76fd939eb113f6189e487ba1772bd7fd
diff --git a/examples/pie_and_polar_charts/polar_bar_demo.py b/examples/pie_and_polar_charts/polar_bar_demo.py
@@ -10,10 +10,34 @@
 ex_radii = 10 * np.random.rand(N)
 ex_width = np.pi / 4 * np.random.rand(N)

+ax = plt.subplot(111, polar=True)

-def polar_bar_demo(theta,radii,width):
+def polar_bar_demo(ax,theta,radii,width):
+    """
+    produces a randomly colored polar plot given three arrays,
+    theta, radii,width .
+
+    Parameters
+    ----------
+    ax :  PolarAxesSubplot
+          Axes on which to plot polar_bar
+
+    theta : array
+            Angles at which to plot polar bars
+
+    radii : array
+            lengths of polar bar
+
+    width : array
+            widths of polars bars
+
+    Returns
+    -------
+    ax : PolarAxesSubplot
+
+         Returns axes for further modification.
+    """

-    ax = plt.subplot(111, polar=True)
    bars = ax.bar(theta, radii, width=width, bottom=0.0)

 # Use custom colors and opacity
@@ -24,4 +48,4 @@ def polar_bar_demo(theta,radii,width):
    plt.show()
    return ax

-polar_bar_demo(ex_theta,ex_radii,ex_width)
+polar_bar_demo(ax,ex_theta,ex_radii,ex_width)