Minor docs updates + typo fixes

Author: lukelbd

docs/basics.py

@@ -48,7 +48,7 @@
 #    so that the figure backgrounds shown by the `matplotlib backend
 #    <https://matplotlib.org/faq/usage_faq#what-is-a-backend>`__ are light gray
 #    (the :rcraw:`savefig.facecolor` applied to saved figures is still white).
-#    Proplot also controls the appearence of figures in Jupyter notebooks
+#    Proplot also controls the appearance of figures in Jupyter notebooks
 #    using the new :rcraw:`inlinefmt` setting, which is passed to
 #    `~proplot.config.config_inline_backend` on import. This
 #    imposes a higher-quality default `"inline" format
@@ -232,8 +232,9 @@
 #   In other words, if you make a single subplot with ``fig, axs = pplt.subplots()``,
 #   then ``axs[0].method(...)`` is equivalent to ``axs.method(...)``.
 # * `~proplot.gridspec.SubplotGrid` permits list-like 1D indexing, e.g. ``axs[1]``
-#   to return the second subplot. The subplots in the grid are sorted by `number`
-#   (see :ref:`this page <ug_abc>` for details on changing the `number` order).
+#   to return the second subplot. The subplots in the grid are sorted by
+#   `~proplot.axes.Axes.number` (see :ref:`this page <ug_abc>` for details
+#   on changing the `~proplot.axes.Axes.number` order).
 # * `~proplot.gridspec.SubplotGrid` permits array-like 2D indexing, e.g.
 #   ``axs[1, 0]`` to return the subplot in the second row, first column, or
 #   ``axs[:, 0]`` to return a `~proplot.gridspec.SubplotGrid` of every subplot
@@ -242,8 +243,7 @@
 #
 # `~proplot.gridspec.SubplotGrid` includes methods for working
 # simultaneously with different subplots. Currently, this includes
-# the `~proplot.gridspec.SubplotGrid` commands
-# `~proplot.gridspec.SubplotGrid.format`,
+# the commands `~proplot.gridspec.SubplotGrid.format`,
 # `~proplot.gridspec.SubplotGrid.panel_axes`,
 # `~proplot.gridspec.SubplotGrid.inset_axes`,
 # `~proplot.gridspec.SubplotGrid.altx`, and `~proplot.gridspec.SubplotGrid.alty`.
@@ -257,7 +257,7 @@
 #    `~proplot.figure.Figure.add_subplot`, a `~proplot.gridspec.SubplotGrid`
 #    containing the numbered subplots is available via the
 #    `proplot.figure.Figure.subplotgrid` property. As with subplots made
-#    all-at-once, the subplots in the grid are sorted by `number`.
+#    all-at-once, the subplots in the grid are sorted by `~proplot.axes.Axes.number`.
 
 # %%
 import proplot as pplt
@@ -353,7 +353,9 @@
 # a "python-style" object-oriented interface with instance-level commands
 # like `matplotlib.axes.Axes.set_title`, and a "MATLAB-style" interface
 # that tracks current axes and provides global commands like
-# `matplotlib.pyplot.title`. Proplot provides the ``format`` command as an
+# `matplotlib.pyplot.title`.
+#
+# Proplot provides the ``format`` command as an
 # alternative "python-style" command for formatting a variety of plot elements.
 # While matplotlib's one-liner commands still work, ``format`` only needs to be
 # called once and tends to cut down on boilerplate code. You can call
@@ -399,17 +401,16 @@
 #   See :ref:`this section <ug_config>` for more on rc settings.
 #
 # A ``format`` command is available on every figure and axes.
-# Notably, `proplot.figure.Figure.format` accepts both figure and axes
-# settings (applying them to each numbered subplot by default). Likewise,
-# `proplot.axes.Axes.format` accepts both axes and figure settings.
-# There is also a `proplot.gridspec.SubplotGrid.format` command
-# that can be used to change settings for a subset of subplots
-# -- for example, ``axs[:2].format(xtickminor=True)``
+# `proplot.figure.Figure.format` accepts both figure and axes
+# settings (applying them to each numbered subplot by default).
+# Similarly, `proplot.axes.Axes.format` accepts both axes and figure
+# settings. There is also a `proplot.gridspec.SubplotGrid.format`
+# command that can be used to change settings for a subset of
+# subplots -- for example, ``axs[:2].format(xtickminor=True)``
 # turns on minor ticks for the first two subplots (see
 # :ref:`this section <ug_subplotgrid>` for more on subplot grids).
-#
-# The below example shows the many different keyword arguments
-# accepted by ``format``, and demonstrates how ``format`` can be
+# The below example shows the many keyword arguments accepted
+# by ``format``, and demonstrates how ``format`` can be
 # used to succinctly and efficiently customize plots.
 
 # %%

docs/cartesian.py

@@ -359,8 +359,8 @@
 #   axis scales now accept the keywords `base`, `linthresh`, `linscale`, and
 #   `subs` rather than keywords with trailing ``x`` or ``y``.
 #
-# Proplot also includes a few new axis scales. The ``'cutoff'`` scale (see
-# `~proplot.scale.CutoffScale`) is useful when the statistical distribution
+# Proplot also includes a few new axis scales. The ``'cutoff'`` scale
+# `~proplot.scale.CutoffScale` is useful when the statistical distribution
 # of your data is very unusual. The ``'sine'`` scale `~proplot.scale.SineLatitudeScale`
 # scales the axis with a sine function (resulting in an area-weighted spherical latitude
 # coordinate) and the ``'mercator'`` scale `~proplot.scale.MercatorLatitudeScale`

docs/colorbars_legends.py

@@ -117,8 +117,9 @@
 # or `~proplot.axes.PlotAxes.contour`). To pass keyword arguments to the colorbar
 # and legend commands, use the `legend_kw` and `colorbar_kw` arguments (e.g.,
 # ``legend_kw={'ncol': 3}``). Note that `~proplot.axes.Axes.colorbar` can also
-# build colorbars from lists of arbitrary matplotlib artists, for example the lines
-# generated by `~proplot.axes.PlotAxes.plot` (see :ref:`below <ug_colorbars>`).
+# build colorbars from lists of arbitrary matplotlib artists, for example the
+# lines generated by `~proplot.axes.PlotAxes.plot` or `~proplot.axes.PlotAxes.line`
+# (see :ref:`below <ug_colorbars>`).
 #
 # .. note::
 #

docs/colormaps.py

@@ -469,14 +469,14 @@
 # `HCLWizard <http://hclwizard.org:64230/hclwizard/>`__,
 # `HCL picker <http://tristen.ca/hcl-picker/>`__,
 # `SciVisColor <https://sciviscolor.org/home/colormaps/>`__,
-# and `CCC-tool <https://ccctool.com>`__,
+# and `CCC-tool <https://ccctool.com>`__.
 #
 # To add colormaps downloaded from any of these sources, save the color data file
 # to the ``cmaps`` subfolder inside `~proplot.config.Configurator.user_folder`,
 # or to a folder named ``proplot_cmaps`` in the same directory as your python session
 # or an arbitrary parent directory (see `~proplot.config.Configurator.local_folders`).
 # After adding the file, call `~proplot.config.register_cmaps` or restart your python
 # session. You can also use `~proplot.colors.ContinuousColormap.from_file` or manually
-# pass `~proplot.config.ContinuousColormap` instances or file paths to
+# pass `~proplot.colors.ContinuousColormap` instances or file paths to
 # `~proplot.config.register_cmaps`. See `~proplot.config.register_cmaps`
 # for a table of recognized file extensions.

docs/subplots.py

@@ -45,9 +45,8 @@
 # A-b-c labels
 # ------------
 #
-# Proplot can quickly add "a-b-c" labels to subplots. This is possible because we
-# assign a `~proplot.axes.Axes.number` to each subplot.
-#
+# Proplot can quickly add "a-b-c" labels using the
+# `~proplot.axes.Axes.number` assigned to each subplot.
 # If you add subplots one-by-one with `~proplot.figure.Figure.add_subplot`, you can
 # manually specify the number with the `number` keyword. By default, the subplot number
 # is incremented by ``1`` each time you call `~proplot.figure.Figure.add_subplot`.
@@ -213,8 +212,8 @@
 # %% [raw] raw_mimetype="text/restructuredtext"
 # .. _ug_tight:
 #
-# Spaces and tight layout
-# -----------------------
+# Spacing and tight layout
+# ------------------------
 #
 # Proplot automatically adjusts the spacing between subplots
 # by default to accomadate labels using its own `"tight layout" algorithm
@@ -319,8 +318,8 @@
 # %% [raw] raw_mimetype="text/restructuredtext" tags=[]
 # .. _ug_share:
 #
-# Axis sharing
-# ------------
+# Axis label sharing
+# ------------------
 #
 # Figures with lots of subplots often have :ref:`redundant labels <why_redundant>`.
 # To help address this, the matplotlib command `matplotlib.pyplot.subplots` includes

docs/why.rst

@@ -808,8 +808,8 @@ string units for these keywords, for the `~proplot.figure.Figure` keywords
 `figsize`, `figwidth`, `figheight`, `refwidth`, and `refheight`, and in a
 few other places. This is powered by the physical units engine `~proplot.utils.units`.
 Acceptable units include inches, centimeters, millimeters,
-pixels, `points <https://en.wikipedia.org/wiki/Point_(typography)>`__, `picas
-<https://en.wikipedia.org/wiki/Pica_(typography)>`__, and (a table of acceptable
+pixels, `points <https://en.wikipedia.org/wiki/Point_(typography)>`__, and `picas
+<https://en.wikipedia.org/wiki/Pica_(typography)>`__ (a table of acceptable
 units is found :ref:`here <units_table>`). Note the `~proplot.utils.units` engine
 also translates rc settings assigned to `~proplot.config.rc_matplotlib` and
 `~proplot.config.rc_proplot`, e.g. :rcraw:`subplots.refwidth`,

proplot/axes/base.py

@@ -2874,7 +2874,7 @@ def colorbar(self, mappable, values=None, loc=None, location=None, **kwargs):
     @docstring._snippet_manager
     def legend(self, handles=None, labels=None, loc=None, location=None, **kwargs):
         """
-        Add an *inset* legend or *outer* legend along the edge of the axes.
+        Add an inset legend or outer legend along the edge of the axes.
 
         Parameters
         ----------
@@ -3068,7 +3068,7 @@ def _iter_axes(self, hidden=False, children=False, panels=True):
     def number(self):
         """
         The axes number. This controls the order of a-b-c labels and the
-        order of appearence in the `~proplot.gridspec.SubplotGrid` returned
+        order of appearance in the `~proplot.gridspec.SubplotGrid` returned
         by `~proplot.figure.Figure.subplots`.
         """
         return self._number

proplot/figure.py

@@ -1607,7 +1607,7 @@ def colorbar(
         space=None, pad=None, width=None, **kwargs
     ):
         """
-        Draw a colorbar along the side of the figure.
+        Add a colorbar along the side of the figure.
 
         Parameters
         ----------
@@ -1676,7 +1676,7 @@ def legend(
         space=None, pad=None, width=None, **kwargs
     ):
         """
-        Draw a legend along the side of the figure.
+        Add a legend along the side of the figure.
 
         Parameters
         ----------

proplot/scale.py

@@ -471,7 +471,7 @@ class ExpScale(_Scale, mscale.ScaleBase):
 
         (\log_a(x) - \log_a(C))/b
 
-    which in appearence is equivalent to `LogScale` since it is just a linear
+    which in appearance is equivalent to `LogScale` since it is just a linear
     transformation of the logarithm.
     """
     #: The registered scale name