Include the Norm ABC in the docs

trygvrad · trygvrad · commit d26581fbb58e · 2025-06-24T23:08:16.000+02:00
diff --git a/doc/api/colors_api.rst b/doc/api/colors_api.rst
@@ -21,6 +21,7 @@ Color norms
    :toctree: _as_gen/
    :template: autosummary.rst
 
+   Norm
    Normalize
    NoNorm
    AsinhNorm
diff --git a/lib/matplotlib/colors.py b/lib/matplotlib/colors.py
@@ -2311,7 +2311,6 @@ def __call__(self, value, clip=None):
         Notes
         -----
         If not already initialized, ``self.vmin`` and ``self.vmax`` are
-
         initialized using ``self.autoscale_None(value)``.
         """
         pass
@@ -2434,11 +2433,7 @@ def vmax(self, value):
 
     @property
     def clip(self):
-        """
-        Determines the behavior for mapping values outside the range ``[vmin, vmax]``.
-
-        See the *clip* parameter in `.Normalize`.
-        """
+        # docstring inherited
         return self._clip
 
     @clip.setter
@@ -2488,24 +2483,7 @@ def process_value(value):
         return result, is_scalar
 
     def __call__(self, value, clip=None):
-        """
-        Normalize the data and return the normalized data.
-
-        Parameters
-        ----------
-        value
-            Data to normalize.
-        clip : bool, optional
-            See the description of the parameter *clip* in `.Normalize`.
-
-            If ``None``, defaults to ``self.clip`` (which defaults to
-            ``False``).
-
-        Notes
-        -----
-        If not already initialized, ``self.vmin`` and ``self.vmax`` are
-        initialized using ``self.autoscale_None(value)``.
-        """
+        # docstring inherited
         if clip is None:
             clip = self.clip
 
@@ -2535,15 +2513,7 @@ def __call__(self, value, clip=None):
         return result
 
     def inverse(self, value):
-        """
-        Maps the normalized value (i.e., index in the colormap) back to image
-        data value.
-
-        Parameters
-        ----------
-        value
-            Normalized value.
-        """
+        # docstring inherited
         if not self.scaled():
             raise ValueError("Not invertible until both vmin and vmax are set")
         (vmin,), _ = self.process_value(self.vmin)
@@ -2556,7 +2526,7 @@ def inverse(self, value):
             return vmin + value * (vmax - vmin)
 
     def autoscale(self, A):
-        """Set *vmin*, *vmax* to min, max of *A*."""
+        # docstring inherited
         with self.callbacks.blocked():
             # Pause callbacks while we are updating so we only get
             # a single update signal at the end
@@ -2565,7 +2535,7 @@ def autoscale(self, A):
         self._changed()
 
     def autoscale_None(self, A):
-        """If *vmin* or *vmax* are not set, use the min/max of *A* to set them."""
+        # docstring inherited
         A = np.asanyarray(A)
 
         if isinstance(A, np.ma.MaskedArray):
@@ -2579,7 +2549,7 @@ def autoscale_None(self, A):
             self.vmax = A.max()
 
     def scaled(self):
-        """Return whether *vmin* and *vmax* are both set."""
+        # docstring inherited
         return self.vmin is not None and self.vmax is not None
 
 
