DOC : update bar docstring to numpy doc format

tacaswell · tacaswell · commit a57772a5ec22 · 2015-04-05T22:47:07.000-04:00
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -1819,54 +1819,63 @@ def bar(self, left, height, width=0.8, bottom=None, **kwargs):
         height : sequence of scalars
             the heights of the bars
 
-        width : scalar or array-like, optional, default: 0.8
+        width : scalar or array-like, optional
             the width(s) of the bars
+            default: 0.8
 
-        bottom : scalar or array-like, optional, default: None
+        bottom : scalar or array-like, optional
             the y coordinate(s) of the bars
+            default: None
 
         color : scalar or array-like, optional
             the colors of the bar faces
 
         edgecolor : scalar or array-like, optional
             the colors of the bar edges
 
-        linewidth : scalar or array-like, optional, default: None
+        linewidth : scalar or array-like, optional
             width of bar edge(s). If None, use default
             linewidth; If 0, don't draw edges.
+            default: None
 
-        xerr : scalar or array-like, optional, default: None
+        xerr : scalar or array-like, optional
             if not None, will be used to generate errorbar(s) on the bar chart
+            default: None
 
-        yerr : scalar or array-like, optional, default: None
+        yerr : scalar or array-like, optional
             if not None, will be used to generate errorbar(s) on the bar chart
+            default: None
 
-        ecolor : scalar or array-like, optional, default: None
+        ecolor : scalar or array-like, optional
             specifies the color of errorbar(s)
+            default: None
 
-        capsize : integer, optional, default: 3
+        capsize : integer, optional
            determines the length in points of the error bar caps
+           default: 3
 
-        error_kw :
+        error_kw : dict, optional
             dictionary of kwargs to be passed to errorbar method. *ecolor* and
             *capsize* may be specified here rather than as independent kwargs.
 
-        align : ['edge' | 'center'], optional, default: 'edge'
-            If `edge`, aligns bars by their left edges (for vertical bars) and
-            by their bottom edges (for horizontal bars). If `center`, interpret
+        align : {'edge',  'center'}, optional
+            If 'edge', aligns bars by their left edges (for vertical bars) and
+            by their bottom edges (for horizontal bars). If 'center', interpret
             the `left` argument as the coordinates of the centers of the bars.
             To align on the align bars on the right edge pass a negative
             `width`.
 
-        orientation : 'vertical' | 'horizontal', optional, default: 'vertical'
+        orientation : {'vertical',  'horizontal'}, optional
             The orientation of the bars.
 
-        log : boolean, optional, default: False
-            If true, sets the axis to be log scale
+        log : boolean, optional
+            If true, sets the axis to be log scale.
+            default: False
 
         Returns
         -------
-        `matplotlib.patches.Rectangle` instances.
+        bars : matplotlib.container.BarContainer
+            Container with all of the bars + errorbars
 
         Notes
         -----
