Merge pull request #7758 from lspvic/doc-barh-align

phobson · phobson · commit c4b655b8d997 · 2017-01-08T15:40:12.000-08:00
DOC: fix Axes.barh default alignment option
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -2258,10 +2258,12 @@ def barh(self, bottom, width, height=0.8, left=None, **kwargs):
             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
-            the `left` argument as the coordinates of the centers of the bars.
+        align : {'center', 'edge'}, optional
+            If 'edge', aligns bars by their left edges (for vertical
+            bars) and by their bottom edges (for horizontal bars). If
+            'center', interpret the `bottom` argument as the
+            coordinates of the centers of the bars.  To align on the
+            align bars on the top edge pass a negative 'height'.
 
         log : boolean, optional, default: False
             If true, sets the axis to be log scale
