Update docs

timhoffm · timhoffm · commit 08e154d73f6c · 2024-09-13T14:55:42.000+02:00
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -3013,6 +3013,7 @@ def broken_barh(self, xranges, yrange, **kwargs):
 
         return col
 
+    @_docstring.interpd
     def grouped_bar(self, x, heights, *, group_spacing=1.5, bar_spacing=0,
                     labels=None, orientation="vertical", colors=None,
                     **kwargs):
@@ -3023,6 +3024,10 @@ def grouped_bar(self, x, heights, *, group_spacing=1.5, bar_spacing=0,
             This function is new in v3.10, and the API is still provisional.
             We may still fine-tune some aspects based on user-feedback.
 
+        This is a convenience function to plot bar charts for multiple datasets
+        into one Axes. In particular, it simplifies positioning of the bars
+        compared to individual `~.Axes.bar` plots.
+
         Parameters
         ----------
         x : array-like or list of str
@@ -3039,44 +3044,57 @@ def grouped_bar(self, x, heights, *, group_spacing=1.5, bar_spacing=0,
 
               .. code-block:: none
 
-                 x = ['a', 'b']
-                 group_labels = ['ds0', 'ds1', 'ds2']
+                  x = ["a", "b"]
+
+                  #            x[0]   x[1]
+                  dataset_0 = [ds0_a, ds0_b]
+                  dataset_1 = [ds1_a, ds1_b]
+                  dataset_2 = [ds2_a, ds2_b]
+
+                  heights = [dataset_0, dataset_1, dataset_2]
+
+              Example call::
+
+                  grouped_bar(x, [dataset_0, dataset_1, dataset_2])
+
+            - dict of array-like: A mapping names to datasets. Each dataset
+              (dict value) must have ``len(x)`` elements.
 
-                 # group_labels: ds0   ds1        dw2
-                 heights = [dataset_0, dataset_1, dataset_2]
+              This is similar to passing a list of array-like, with the addition that
+              each dataset gets a name.
 
-                 #            x[0]   x[1]
-                 dataset_0 = [ds0_a, ds0_b]
+              Example call::
 
-                 #           x[0]   x[1]
-                 heights = [[ds0_a, ds0_b],  # dataset_0
-                            [ds1_a, ds1_b],  # dataset_1
-                            [ds2_a, ds2_b],  # dataset_2
-                            ]
+                grouped_bar(x, {'ds0': dataset_0, 'ds1': dataset_1, 'ds2': dataset_2]})
 
-            - dict of array-like: A names to datasets, each dataset (dict value)
-              must have ``len(x)`` elements.
+              The names are used as *labels*, i.e. the following two calls are
+              equivalent::
 
-              group_labels = heights.keys()
-              heights = heights.values()
+                data_dict = {'ds0': dataset_0, 'ds1': dataset_1, 'ds2': dataset_2]}
+                grouped_bar(x, data_dict)
+                grouped_bar(x, data_dict.values(), labels=data_dict.keys())
 
-            - a 2D array: columns map to *x*, columns are the different datasets.
+              When using a dict-like input, you must not pass *labels* explicitly.
+
+            - a 2D array: The columns are the different datasets.
 
               .. code-block:: none
 
                           dataset_0 dataset_1 dataset_2
-                 x[0]='a'  ds0_a     ds1_a     ds2_a
-                 x[1]='b'  ds0_b     ds1_b     ds2_b
+                 x[0]="a"   ds0_a     ds1_a     ds2_a
+                 x[1]="b"   ds0_b     ds1_b     ds2_b
 
-              Note that this is consistent with pandas. These two calls produce
-              the same bar plot structure::
+              .. code-block::
 
-                  grouped_bar(x, array, group_labels=group_labels)
-                  pd.DataFrame(array, index=x, columns=group_labels).plot.bar()
+                  x = ["a", "b"]
+                  dataset_labels = ["dataset_0", "dataset_1", "dataset_2"]
+                  array = np.random.random((2, 3))
 
+              Note that this is consistent with pandas. These two calls produce
+              the same bar plot structure::
 
-            An iterable of array-like: The iteration runs over the groups.
-            Each individual array-like is the list of label values for that group.
+                  grouped_bar(x, array, labels=dataset_labels)
+                  pd.DataFrame(array, index=x, columns=dataset_labels).plot.bar()
 
         group_spacing : float
             The space between two bar groups in units of bar width.
@@ -3091,7 +3109,8 @@ def grouped_bar(self, x, heights, *, group_spacing=1.5, bar_spacing=0,
             Note: The "other" label dimension are the group labels, which
             can be set via *x*.
 
-        orientation : {"vertical", "horizontal"}, default: vertical
+        orientation : {"vertical", "horizontal"}, default: "vertical"
+            The direction of the bars.
 
         colors : list of :mpltype:`color`, optional
             A sequence of colors to be cycled through and used to color bars
@@ -3107,7 +3126,12 @@ def grouped_bar(self, x, heights, *, group_spacing=1.5, bar_spacing=0,
 
         Returns
         -------
-            A list of `.BarContainer` instances, one for each dataset.
+            list of `.BarContainer`
+                The results of the individual `~.Axes.bar` calls for each dataset.
+
+                .. warning::
+                    The return type is provisional and will likely be replaced
+                    by a more convenient object.
 
         """
         if hasattr(heights, 'keys'):
