Merge pull request #29514 from meeseeksmachine/auto-backport-of-pr-29511-on-v3.10.x

rcomer · web-flow · commit ec3c21f9bf43 · 2025-01-24T18:51:32.000Z
Backport PR #29511 on branch v3.10.x (DOC: Document the behavior of bar() for categorical x data)
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -2391,6 +2391,17 @@ def bar(self, x, height, width=0.8, bottom=None, *, align="center",
             The x coordinates of the bars. See also *align* for the
             alignment of the bars to the coordinates.
 
+            Bars are often used for categorical data, i.e. string labels below
+            the bars. You can provide a list of strings directly to *x*.
+            ``bar(['A', 'B', 'C'], [1, 2, 3])`` is often a shorter and more
+            convenient notation compared to
+            ``bar(range(3), [1, 2, 3], tick_label=['A', 'B', 'C'])``. They are
+            equivalent as long as the names are unique. The explicit *tick_label*
+            notation draws the names in the sequence given. However, when having
+            duplicate values in categorical *x* data, these values map to the same
+            numerical x coordinate, and hence the corresponding bars are drawn on
+            top of each other.
+
         height : float or array-like
             The height(s) of the bars.
 
@@ -2706,6 +2717,17 @@ def barh(self, y, width, height=0.8, left=None, *, align="center",
             The y coordinates of the bars. See also *align* for the
             alignment of the bars to the coordinates.
 
+            Bars are often used for categorical data, i.e. string labels below
+            the bars. You can provide a list of strings directly to *y*.
+            ``barh(['A', 'B', 'C'], [1, 2, 3])`` is often a shorter and more
+            convenient notation compared to
+            ``barh(range(3), [1, 2, 3], tick_label=['A', 'B', 'C'])``. They are
+            equivalent as long as the names are unique. The explicit *tick_label*
+            notation draws the names in the sequence given. However, when having
+            duplicate values in categorical *y* data, these values map to the same
+            numerical y coordinate, and hence the corresponding bars are drawn on
+            top of each other.
+
         width : float or array-like
             The width(s) of the bars.
 
