multivar_colorbar: fix for docs

trygvrad · trygvrad · commit d6caaf46ec4b · 2026-04-24T01:39:53.000+02:00
diff --git a/doc/api/figure_api.rst b/doc/api/figure_api.rst
@@ -256,7 +256,8 @@ Annotating
    :nosignatures:
 
    SubFigure.colorbar
-   SubFigure.bivar_colorbar
+   SubFigure.colorbar_bivar
+   SubFigure.colorbar_multivar
    SubFigure.legend
    SubFigure.text
    SubFigure.suptitle
diff --git a/lib/matplotlib/colorbar.py b/lib/matplotlib/colorbar.py
@@ -1417,7 +1417,7 @@ class BivarColorbar:
     r"""
     Draw a bivariate colorbar in an existing Axes.
 
-    Typically, bivariate colorbars are created using `.Figure.bivar_colorbar`
+    Typically, bivariate colorbars are created using `.Figure.colorbar_bivar`
     and associated with `.ColorizingArtist`\s (such as an
     `.AxesImage` generated via `~.axes.Axes.imshow`).
 
@@ -1444,9 +1444,6 @@ def __init__(
         mappable : `.ColorizingArtist`
             The mappable whose colormap and norm will be used.
 
-            To show the colors versus index instead of on a 0-1 scale, set the
-            mappable's norm to ``colors.NoNorm()``.
-
         alpha : float
             The colorbars transparency between 0 (transparent) and 1 (opaque).
 
@@ -1608,36 +1605,6 @@ def xaxis(self):
     def yaxis(self):
         return self.ax.yaxis
 
-    """
-    def _y_limits_changed(self, ax=None):
-        if not self._allow_change_limits:
-            ylim = self.ax.get_ylim()
-            if self.colorizer.norm.norms[0].vmin != ylim[0]:
-                self.colorizer.norm.norms[0].vmin = ylim[0]
-            if self.colorizer.norm.norms[0].vmax != ylim[1]:
-                self.colorizer.norm.norms[0].vmax = ylim[1]
-
-    def _x_limits_changed(self, ax=None):
-        if not self._allow_change_limits:
-            xlim = self.ax.get_xlim()
-            if self.colorizer.norm.norms[1].vmin != xlim[0]:
-                self.colorizer.norm.norms[1].vmin = xlim[0]
-            if self.colorizer.norm.norms[1].vmax != xlim[1]:
-                self.colorizer.norm.norms[1].vmax = xlim[1]
-    """
-    """
-    def _update_limits(self, ax=None):
-        if not self._allow_change_limits:
-            ylim = self.ax.get_ylim()
-            xlim = self.ax.get_xlim()
-            if (self.colorizer.norm.norms[0].vmin != ylim[0] or
-                    self.colorizer.norm.norms[0].vmax != ylim[1] or
-                    self.colorizer.norm.norms[1].vmin != xlim[0] or
-                    self.colorizer.norm.norms[1].vmax != xlim[1]):
-                raise ValueError("Changing the limits of this axis must be done "
-                                 "using the norm attached to the bivariate colorbar.")
-    """
-
     def update_normals(self, mappable=None):
         self.set_alpha(self.mappable.get_alpha())
         #self._draw_all()
@@ -1721,7 +1688,48 @@ def _cbar_cla(self):
 
 
 class MultivarColorbar(Sequence):
+    r"""
+    Draw a multivariate colorbar in existing Axes.
+
+    Typically, multivariate colorbars are created using `.Figure.colorbar_multivar`
+    and associated with `.ColorizingArtist`\s (such as an
+    `.AxesImage` generated via `~.axes.Axes.imshow`).
+
+    MultivarColorbar is iterable, and the constituent Colorbar objects can be accessed
+    by index.
+    """
+
     def __init__(self, axes, mappable=None, **kwargs):
+        """
+        Parameters
+        ----------
+        axes : list of `~matplotlib.axes.Axes`
+            The `~.axes.Axes` instances in which the colorbars are drawn.
+
+        mappable : `.ColorizingArtist`
+            The mappable whose colormap and norm will be used.
+
+        alpha : float
+            The colorbars transparency between 0 (transparent) and 1 (opaque).
+
+        location : None or {'left', 'right', 'top', 'bottom'}
+            Set the multivariate colorbars's location
+
+        Other Parameters
+        ----------------
+        orientation : None or {'vertical', 'horizontal'}
+            If None, use the value determined by *location*. If both
+            *orientation* and *location* are None then defaults to 'vertical'.
+
+        ticklocation : {'auto', 'left', 'right', 'top', 'bottom'}
+            The location of the colorbar ticks. The *ticklocation* must match
+            *orientation*. For example, a horizontal colorbar can only have ticks
+            at the top or the bottom. If 'auto', the ticks will be the same as
+            *location*, so a colorbar to the left will have ticks to the left. If
+            *location* is None, the ticks will be at the bottom for a horizontal
+            colorbar and at the right for a vertical.
+        """
+
         if isinstance(mappable, mpl.colorizer.Colorizer):
             mappable = mcolorizer.ColorizingArtist(mappable)
 
@@ -2167,7 +2175,7 @@ def make_axes(parents, location=None, orientation=None, fraction=0.15,
 def make_bivar_axes(parents, location=None, fraction=0.15,
                     shrink=1.0, aspect=1.0, **kwargs):
     """
-    Create an `~.axes.Axes` suitable for a bivar_colorbar.
+    Create an `~.axes.Axes` suitable for a bivariate colorbar.
 
     The Axes is placed in the figure of the *parents* Axes, by resizing and
     repositioning *parents*.
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -1337,8 +1337,8 @@ def colorbar_bivar(
         Parameters
         ----------
         mappable
-            The `matplotlib.colorizer.ColorizingArtist` (i.e., `.AxesImage`,
-            `.ContourSet`, etc.) described by this bivariate colorbar.
+            The `matplotlib.colorizer.ColorizingArtist` (i.e., `.AxesImage`
+            etc.) described by this bivariate colorbar.
             This argument is mandatory for the `.Figure.colorbar_bivar` method
             but optional for the`.pyplot.colorbar_bivar` function, which sets
             the default to the current image.
@@ -1424,6 +1424,39 @@ def colorbar_bivar(
     def colorbar_multivar(
             self, mappable, *, caxes=None, ax=None,
             n_major=-1, **kwargs):
+        """
+        Add a bivariate colorbar to a plot.
+
+        Parameters
+        ----------
+        mappable
+            The `matplotlib.colorizer.ColorizingArtist` (i.e., `.AxesImage`
+            etc.) described by this multivariate colorbar.
+            This argument is mandatory for the `.Figure.colorbar_multivar` method
+            but optional for the`.pyplot.colorbar_multivar` function, which sets
+            the default to the current image.
+
+        caxes : `~matplotlib.axes.Axes`, optional
+            Axes into which the colorbar will be drawn.  If `None`, then new
+            Axes are created and the space for it will be stolen from the Axes(s)
+            specified in *ax*.
+
+        ax : `~matplotlib.axes.Axes` or iterable or `numpy.ndarray` of Axes, optional
+            The one or more parent Axes from which space for a new colorbar Axes
+            will be stolen. This parameter is only used if *cax* is not set.
+
+            Defaults to the Axes that contains the mappable used to create the
+            colorbar.
+
+        Returns
+        -------
+        multivariate_colorbar : `~matplotlib.colorbar.MultivarColorbar`
+
+        Other Parameters
+        ----------------
+        %(_make_multivar_axes_kw_doc)s
+
+        """
 
         if isinstance(mappable, mpl.colorizer.Colorizer):
             mappable = mcolorizer.ColorizingArtist(mappable)
