Minor docs cleanup

Author: lukelbd

WHATSNEW.rst

@@ -31,21 +31,23 @@ and stability is improved.
 Version 0.9.5 (2021-XX-XX)
 ==========================
 
-Features
---------
+Style changes
+-------------
 
 * Switch default :rcraw:`cmap.diverging` from ``'NegPos'`` to the more
-  contrasty and commonly-used ``'RdBu_r'`` (:commit:`b0b8557f`).
+  popular and contrasty colormap ``'RdBu_r'`` (:commit:`b0b8557f`).
 * Switch default :rcraw:`cmap.qualitative` from ``'flatui'`` to ``'colorblind10'``,
   consistent with the default color cycle ``'colorblind'`` (:commit:`b0b8557f`).
-* Apply ``positive=True``, ``negative=True``, and ``symmetric=True`` even when
-  ``discrete=False`` by modifying `vmin` and `vmax` (:commit:`fbca1063`).
-* Improve ``positive=True``, ``negative=True``, and ``symmetric=True`` behavior
-  when ``discrete=True`` by modifying `vmin` and `vmax` rather than filtering
-  level lists (:commit:`fbca1063`). This fixes issues where too few levels are made.
+
+Features
+--------
+
+* Apply ``positive=True``, ``negative=True``, and ``symmetric=True`` by modifying `vmin`
+  and `vmax` rather than levels (:commit:`fbca1063`). This permits using these keywords
+  even when ``discrete=False`` and fixes too-few-levels issues when ``discrete=True``.
 * Improve default string representation of axes generated with
   `~proplot.axes.CartesianAxes.altx`, `~proplot.axes.CartesianAxes.alty`,
-  or `~proplot.axes.CartesianAxes.inset_axes` (:commit:`a570fca7`).
+  or `~proplot.axes.Axes.inset_axes` (:commit:`a570fca7`).
 
 Bug fixes
 ---------
@@ -69,8 +71,8 @@ Bug fixes
 * Fix issue where `~proplot.colors.SegmentedNorm` cannot be specified with
   ``norm='segmented'`` and ``norm_kw={'levels': level}`` when `discrete`
   is also disabled (:commit:`a4f6e838`).
-* Fix issue where more than one of mutually exclusive `sequential`, `diverging`,
-  `cyclic`, and `qualitative` settings can be set to ``True`` and others
+* Fix issue where more than one of mutually-exclusive `sequential`, `diverging`,
+  `cyclic`, and `qualitative` keywords can be set to ``True`` and others
   are silently ignored without warning (:commit:`f14aa263`).
 
 Version 0.9.4 (2021-10-16)

docs/2dplots.py

@@ -259,8 +259,8 @@
 fig = pplt.figure(refwidth=2.2, span=False, suptitle='Colormap types')
 axs = fig.subplots(ncols=2, nrows=2)
 axs.format(xformatter='none', yformatter='none')
-axs[0].pcolor(data, sequential=True, colorbar='l')
-axs[1].pcolor(data - 5, diverging=True, colorbar='r')
+axs[0].pcolor(data, sequential=True, colorbar='l', extend='max')
+axs[1].pcolor(data - 5, diverging=True, colorbar='r', extend='both')
 axs[2].pcolor(data % 8, cyclic=True, colorbar='l')
 axs[3].pcolor(data, levels=pplt.arange(0, 12, 2), qualitative=True, colorbar='r')
 types = ('sequential', 'diverging', 'cyclic', 'qualitative')
@@ -433,7 +433,7 @@
 #
 # #. All colormaps always span the *entire color range*,
 #    independent of the `extend` setting.
-# #. Cyclic colormaps always have *discrete color levels*
+# #. Cyclic colormaps always have *distinct color levels*
 #    on either end of the colorbar.
 #
 # To explicitly toggle discrete levels on or off, change :rcraw:`cmap.discrete`

docs/basics.py

@@ -270,8 +270,8 @@
 # still work, ``format`` is usually more succinct -- it only needs to be called once.
 # You can also pass arbitrary ``format`` arguments to axes-creation commands
 # like `~proplot.figure.Figure.subplots`, `~proplot.figure.Figure.add_subplot`,
-# `~proplot.axes.Axes.inset_axes`, `~proplot.axes.Axes.panel_axes`,
-# and `~proplot.axes.Axes.twinx` or `~proplot.axes.Axes.twiny`. The keyword
+# `~proplot.axes.Axes.inset_axes`, `~proplot.axes.Axes.panel_axes`, and
+# `~proplot.axes.CartesianAxes.altx` or `~proplot.axes..Axes.alty`. The keyword
 # arguments accepted by ``format`` fall into the following groups:
 #
 # * Figure settings. These are related to row labels, column labels, and
@@ -295,10 +295,9 @@
 #   and :ref:`this section <ug_polar>` for details.
 #
 # * Geographic axes settings (valid only for `~proplot.axes.GeoAxes`).
-#   These are related to meridional and parallel grid lines, bounds, and labels,
-#   along with basic geographic features -- for example,
-#   ``ax.format(latlim=(0, 90))`` changes the meridional bounds.
-#   See `proplot.axes.GeoAxes.format`
+#   These are related to map bounds, meridian and parallel lines and labels,
+#   and geographic features -- for example, ``ax.format(latlim=(0, 90))``
+#   changes the meridional bounds. See `proplot.axes.GeoAxes.format`
 #   and :ref:`this section <ug_geoformat>` for details.
 #
 # * `~proplot.config.rc` settings. Any keyword matching the name

docs/colors.py

@@ -120,14 +120,15 @@
 # ---------------------
 #
 # If you want to draw an individual color from a colormap or a color cycle,
-# use ``color=(cmap, coord)`` or ``color=(cycle, index)`` with any command
-# that accepts the `color` keyword. The ``coord`` should be between ``0`` and
-# ``1``, while the ``index`` is the index on the list of cycle colors. This
-# feature is powered by the `~proplot.colors.ColorDatabase` class. This is
-# useful if you spot a nice color in one of the available colormaps or color
-# cycles and want to use it for some arbitrary plot element. Use the
-# `~proplot.utils.to_rgb` or `~proplot.utils.to_rgba` functions to retrieve
-# the RGB or RGBA channel values.
+# use ``key=(cmap, coord)`` or ``key=(cycle, index)`` with any keyword `key`
+# that accepts color specifications (e.g., `color`, `edgecolor`, or `facecolor`).
+# The ``coord`` should be a float between ``0`` and ``1``, denoting the coordinate
+# within a smooth colormap, while the ``index`` should be the integer index
+# on the discrete colormap color list. This feature is powered by the
+# `~proplot.colors.ColorDatabase` class. This is useful if you spot a
+# nice color in one of the available colormaps or color cycles and want
+# to use it for some arbitrary plot element. Use the `~proplot.utils.to_rgb` or
+# `~proplot.utils.to_rgba` functions to retrieve the RGB or RGBA channel values.
 
 # %%
 import proplot as pplt