Actions by @NelleV.

Author: pelson

doc/api/colors_api.rst

@@ -2,8 +2,8 @@
 colors
 ******
 
-For a plot showing the available matplotlib colormaps see the
-:ref:`colormap <pylab_examples-show_colormaps>` example.
+For a visual representation of the matplotlib colormaps, see the
+"Color" section in the gallery.
 
 
 :mod:`matplotlib.colors`

doc/api/matplotlib_configuration_api.rst

@@ -2,7 +2,6 @@ The top level :mod:`matplotlib` module
 ======================================
 
 .. automodule:: matplotlib
-   :members: rc, rcdefaults, use
    :members:
    :undoc-members:
    :show-inheritance:

…ples/pylab_examples/pcolormesh_levels.py …contours_and_fields/pcolormesh_levels.pyexamples/pylab_examples/pcolormesh_levels.py renamed to examples/images_contours_and_fields/pcolormesh_levels.py examples/pylab_examples/pcolormesh_levels.py renamed to examples/images_contours_and_fields/pcolormesh_levels.py

@@ -163,16 +163,22 @@ def get_cmap(name=None, lut=None):
 
 class ScalarMappable:
     """
-    This is a mixin class to support scalar -> RGBA mapping.  Handles
-    normalization and colormapping
-    """
+    This is a mixin class to support scalar data to RGBA mapping.
+    The ScalarMappable makes use of data normalization before returning
+    RGBA colors from the given colormap.
 
+    """
     def __init__(self, norm=None, cmap=None):
-        """
-        *norm* is an instance of :class:`matplotlib.colors.Normalize` or
-        one of its subclasses, used to map luminance to 0-1. *cmap* is a
-        :mod:`~matplotlib.cm.Colormap` instance, for example
-        :data:`matplotlib.cm.jet`.
+        r"""
+
+        Parameters
+        ----------
+        norm : :class:`matplotlib.colors.Normalize` instance
+            The normalizing object which scales data, typically into the
+            interval ``[0, 1]``.
+        cmap : str or :class:`~matplotlib.colors.Colormap` instance
+            The colormap used to map normalized data values to RGBA colors.
+
         """
 
         self.callbacksSM = cbook.CallbackRegistry()
@@ -182,8 +188,10 @@ def __init__(self, norm=None, cmap=None):
         if norm is None:
             norm = colors.Normalize()
 
-        self._A = None
+        self._A = None;
+        #; The Normalization instance of this ScalarMappable.
         self.norm = norm
+        #; The Colormap instance of this ScalarMappable.
         self.cmap = get_cmap(cmap)
         self.colorbar = None
         self.update_dict = {'array': False}

lib/matplotlib/cm.py

@@ -483,13 +483,15 @@ class Colormap(object):
     Typically Colormap instances are used to convert data values (floats) from
     the interval ``[0, 1]`` to the RGBA color that the respective Colormap
     represents. For scaling of data into the ``[0, 1]`` interval see
-    :class:`matplotlib.colors.Normalize`.
+    :class:`matplotlib.colors.Normalize`. It is worth noting that
+    :class:`matplotlib.cm.ScalarMappable` subclasses make heavy use of this
+    ``data->normalize->map-to-color`` processing chain.
 
     """
     def __init__(self, name, N=256):
-        """
+        r"""
         Parameters
-
+        ----------
         name : str
             The name of the colormap.
         N : int
@@ -508,25 +510,23 @@ def __init__(self, name, N=256):
 
     def __call__(self, X, alpha=None, bytes=False):
         """
-        Parameters:
-
+        Parameters
+        ----------
         X : scalar, ndarray
             The data value(s) to convert to RGBA.
             For floats, X should be in the interval ``[0.0, 1.0]`` to
             return the RGBA values ``X*100`` percent along the Colormap line.
             For integers, X should be in the interval ``[0, Colormap.N)`` to
             return RGBA values *indexed* from the Colormap with index ``X``.
-
         alpha : float, None
             Alpha must be a scalar between 0 and 1, or None.
-
         bytes : bool
             If False (default), the returned RGBA values will be floats in the
             interval ``[0, 1]`` otherwise they will be uint8s in the interval
             ``[0, 255]``.
 
-        Returns:
-
+        Returns
+        -------
         Tuple of RGBA values if X is scalar, othewise an array of
         RGBA values with a shape of ``X.shape + (4, )``.