Documentation tweaks from review.

efiring · efiring · commit a4aafd1895f0 · 2020-05-30T13:33:09.000-10:00
diff --git a/doc/users/next_whats_new/2020-05-28-extend_kwarg_to_BoundaryNorm.rst b/doc/users/next_whats_new/2020-05-28-extend_kwarg_to_BoundaryNorm.rst
@@ -1,14 +1,15 @@
 New "extend" keyword to colors.BoundaryNorm
 -------------------------------------------
 
-`~.colors.BoundaryNorm` now has an ``extend`` kwarg,
-analogous to ``extend`` in ~.axes._axes.Axes.contourf`. When set to
-'both', 'min', or 'max', it interpolates such that the corresponding
-out-of-range values are mapped to colors distinct from their in-range
-neighbors.  The colorbar inherits the ``extend`` argument from the
-norm, so with ``extend='both'``, for example, the colorbar will have
-triangular extensions for out-of-range values with colors that differ
-from adjacent colors.
+`~.colors.BoundaryNorm` now has an ``extend`` keyword argument, analogous to
+``extend`` in ~.axes._axes.Axes.contourf`. When set to 'both', 'min', or 'max',
+it maps the corresponding out-of-range values to `~.colors.Colormap`
+lookup-table indices near the appropriate ends of their range so that the
+colors for out-of range values are adjacent to, but distinct from, their
+in-range neighbors.  The colorbar inherits the ``extend`` argument from the
+norm, so with ``extend='both'``, for example, the colorbar will have triangular
+extensions for out-of-range values with colors that differ from adjacent
+colors.
 
   .. plot::
 
diff --git a/lib/matplotlib/colors.py b/lib/matplotlib/colors.py
@@ -1434,7 +1434,7 @@ def __init__(self, boundaries, ncolors, clip=False, extend='neither'):
             pair of boundaries is mapped will be distinct from the first
             color in the colormap, and by default a
             `~matplotlib.colorbar.Colorbar` will be drawn with
-            the triangle extension on the left side.
+            the triangle extension on the left or lower end.
 
         Notes
         -----
diff --git a/tutorials/colors/colorbar_only.py b/tutorials/colors/colorbar_only.py
@@ -42,10 +42,10 @@
 ###############################################################################
 # Extended colorbar with continuous colorscale
 # --------------------------------------------
-
+#
 # The second example shows how to make a discrete colorbar based on a
-# continuous cmap. With the "extend" kwarg the appropriate colors are chosen to
-# fill the colorspace, including the extensions:
+# continuous cmap. With the "extend" keyword argument the appropriate colors
+# are chosen to fill the colorspace, including the extensions:
 fig, ax = plt.subplots(figsize=(6, 1))
 fig.subplots_adjust(bottom=0.5)
 
@@ -62,7 +62,7 @@
 # Discrete intervals colorbar
 # ---------------------------
 #
-# The second example illustrates the use of a
+# The third example illustrates the use of a
 # :class:`~matplotlib.colors.ListedColormap` which generates a colormap from a
 # set of listed colors, `.colors.BoundaryNorm` which generates a colormap
 # index based on discrete intervals and extended ends to show the "over" and
@@ -74,11 +74,15 @@
 # bounds array must be one greater than the length of the color list. The
 # bounds must be monotonically increasing.
 #
-# This time we pass some more arguments in addition to previous arguments to
-# `~.Figure.colorbar`. For the out-of-range values to
-# display on the colorbar, we have to use the *extend* keyword argument. To use
-# *extend*, you must specify two extra boundaries. Finally spacing argument
-# ensures that intervals are shown on colorbar proportionally.
+# This time we pass additional arguments to
+# `~.Figure.colorbar`. For the out-of-range values to display on the colorbar
+# without using the *extend* keyword with
+# `.colors.BoundaryNorm`, we have to use the *extend* keyword argument directly
+# in the colorbar call, and supply an additional boundary on each end of the
+# range.  Here we also
+# use the spacing argument to make
+# the length of each colorbar segment proportional to its corresponding
+# interval.
 
 fig, ax = plt.subplots(figsize=(6, 1))
 fig.subplots_adjust(bottom=0.5)
@@ -92,7 +96,7 @@
 fig.colorbar(
     mpl.cm.ScalarMappable(cmap=cmap, norm=norm),
     cax=ax,
-    boundaries=[0] + bounds + [13],
+    boundaries=[0] + bounds + [13],  # Adding values for extensions.
     extend='both',
     ticks=bounds,
     spacing='proportional',
@@ -104,7 +108,7 @@
 # Colorbar with custom extension lengths
 # --------------------------------------
 #
-# Here we illustrate the use of custom length colorbar extensions, used on a
+# Here we illustrate the use of custom length colorbar extensions, on a
 # colorbar with discrete intervals. To make the length of each extension the
 # same as the length of the interior colors, use ``extendfrac='auto'``.
 
diff --git a/tutorials/colors/colormapnorms.py b/tutorials/colors/colormapnorms.py
@@ -147,7 +147,7 @@
 # which data is to be mapped.  The colors are then linearly distributed between
 # these "bounds".  It can also take an *extend* argument to add upper and/or
 # lower out-of-bounds values to the range over which the colors are
-# distributed For instance:
+# distributed. For instance:
 #
 # .. ipython::
 #

Original file line number	Diff line number	Diff line change
`@@ -147,7 +147,7 @@`
`147`	`147`	`# which data is to be mapped. The colors are then linearly distributed between`
`148`	`148`	`# these "bounds". It can also take an extend argument to add upper and/or`
`149`	`149`	`# lower out-of-bounds values to the range over which the colors are`
`150`		`-# distributed For instance:`
	`150`	`+# distributed. For instance:`
`151`	`151`	`#`
`152`	`152`	`# .. ipython::`
`153`	`153`	`#`