Clean up docs

Author: lukelbd

docs/api.rst

@@ -90,21 +90,21 @@ Projection classes
    :toctree: api
 
 
-Axis scales
-===========
+Locators and formatters
+=======================
 
-.. automodule:: proplot.scale
+.. automodule:: proplot.ticker
 
-.. automodsumm:: proplot.scale
+.. automodsumm:: proplot.ticker
    :toctree: api
 
 
-Locators and formatters
-=======================
+Axis scales
+===========
 
-.. automodule:: proplot.ticker
+.. automodule:: proplot.scale
 
-.. automodsumm:: proplot.ticker
+.. automodsumm:: proplot.scale
    :toctree: api
 
 

docs/axis.py

@@ -423,27 +423,35 @@
 # %%
 import proplot as pplt
 import numpy as np
+
+# Create figure
 pplt.rc.reset()
+state = np.random.RandomState(51423)
+colors = ('coral', 'sky blue')
 fig, axs = pplt.subplots(nrows=2, ncols=3, refwidth=1.7, share=0, order='F')
 axs.format(
-    toplabels=('Power scales', 'Exponential scales', 'Cartographic scales'),
+    toplabels=('Geographic scales', 'Exponential scales', 'Power scales'),
 )
-x = np.linspace(0, 1, 50)
-y = 10 * x
-state = np.random.RandomState(51423)
-data = state.rand(len(y) - 1, len(x) - 1)
 
-# Power scales
-colors = ('coral', 'sky blue')
-for ax, power, color in zip(axs[:2], (2, 1 / 4), colors):
-    ax.pcolormesh(x, y, data, cmap='grays', cmap_kw={'right': 0.8})
-    ax.plot(x, y, lw=4, color=color)
+# Geographic scales
+n = 20
+x = np.linspace(-180, 180, n)
+y1 = np.linspace(-85, 85, n)
+y2 = np.linspace(-85, 85, n)
+data = state.rand(len(x) - 1, len(y2) - 1)
+for ax, scale, color in zip(axs[:2], ('sine', 'mercator'), colors):
+    ax.plot(x, y1, '-', color=color, lw=4)
+    ax.pcolormesh(x, y2, data, cmap='grays', cmap_kw={'right': 0.8})
     ax.format(
-        ylim=(0.1, 10), yscale=('power', power),
-        title=f'$x^{{{power}}}$'
+        title=scale.title() + ' y-axis', yscale=scale, ytickloc='left',
+        yformatter='deg', grid=False, ylocator=20,
+        xscale='linear', xlim=None, ylim=(-85, 85)
     )
 
 # Exp scales
+x = np.linspace(0, 1, 50)
+y = 10 * x
+data = state.rand(len(y) - 1, len(x) - 1)
 for ax, a, c, color in zip(axs[2:4], (np.e, 2), (0.5, 2), colors):
     ax.pcolormesh(x, y, data, cmap='grays', cmap_kw={'right': 0.8})
     ax.plot(x, y, lw=4, color=color)
@@ -452,19 +460,13 @@
         title=f"${(a, 'e')[a == np.e]}^{{{(c, '')[c == 1]}x}}$"
     )
 
-# Geographic scales
-n = 20
-x = np.linspace(-180, 180, n)
-y1 = np.linspace(-85, 85, n)
-y2 = np.linspace(-85, 85, n)
-data = state.rand(len(x) - 1, len(y2) - 1)
-for ax, scale, color in zip(axs[4:], ('sine', 'mercator'), ('coral', 'sky blue')):
-    ax.plot(x, y1, '-', color=color, lw=4)
-    ax.pcolormesh(x, y2, data, cmap='grays', cmap_kw={'right': 0.8})
+# Power scales
+for ax, power, color in zip(axs[4:], (2, 1 / 4), colors):
+    ax.pcolormesh(x, y, data, cmap='grays', cmap_kw={'right': 0.8})
+    ax.plot(x, y, lw=4, color=color)
     ax.format(
-        title=scale.title() + ' y-axis', yscale=scale, ytickloc='left',
-        yformatter='deg', grid=False, ylocator=20,
-        xscale='linear', xlim=None, ylim=(-85, 85)
+        ylim=(0.1, 10), yscale=('power', power),
+        title=f'$x^{{{power}}}$'
     )
 
 

docs/projections.py

@@ -35,9 +35,8 @@
 # a dictionary of projection names with the subplot number as the key -- for example,
 # a 2-column figure with a Cartesian axes on the left and a Plate Carrée projection
 # on the right can be built with either ``proj=('cartesian', 'pcarree')`` or
-# ``proj={2: 'pcarree'}``. The *default* projection is always
-# `~proplot.axes.CartesianAxes` and can be explicitly specified with
-# the ``'cartesian'`` key.
+# ``proj={2: 'pcarree'}``. The default "projection" is `~proplot.axes.CartesianAxes`
+# and can be explicitly specified with the ``'cartesian'`` key.
 
 
 # %% [raw] raw_mimetype="text/restructuredtext"
@@ -47,8 +46,8 @@
 # ---------------
 #
 # ProPlot can create geographic projection axes using
-# either `cartopy`_ or `basemap`_ as "backends". To draw geographic axes, pass
-# ``proj='name'`` or e.g. ``proj={2: 'name'}`` (:ref:`see above <ug_proj>`) to
+# either `cartopy`_ or `basemap`_ as "backends". To create geographic axes, pass
+# ``proj='name'`` or e.g. ``proj={2: 'name'}`` (see :ref:`above <ug_proj>`) to
 # `~proplot.ui.subplots` where ``name`` is any valid :ref:`PROJ projection name
 # <proj_included>`. You can also use ``proj=projection_instance``, where
 # ``projection_instance`` is a `cartopy.crs.Projection` or
@@ -164,8 +163,8 @@
 # %% [raw] raw_mimetype="text/restructuredtext"
 # .. _ug_geoplot:
 #
-# Geographic plotting
-# -------------------
+# Plotting in projections
+# -----------------------
 #
 # In ProPlot, plotting with `~proplot.axes.GeoAxes` is not much different from
 # plotting with `~proplot.axes.CartesianAxes`. ProPlot makes longitude-latitude (i.e.,
@@ -430,15 +429,16 @@
 # Polar axes
 # ----------
 #
-# To draw `polar axes <polar_>`_, pass ``proj='polar'`` or e.g. ``proj={1: 'polar'}``
-# to `~proplot.ui.subplots`. This generates a `proplot.axes.PolarAxes` instance with
-# its own `~proplot.axes.PolarAxes.format` method.
+# To create `polar axes <polar_>`_, pass ``proj='polar'`` or e.g. ``proj={2: 'polar'}``
+# (see :ref:`above <ug_proj>`) to `~proplot.ui.subplots`. This generates a
+# `proplot.axes.PolarAxes` instance with its own `~proplot.axes.PolarAxes.format`
+# method.
 #
 # The `proplot.axes.PolarAxes.format` method facilitates polar-specific axes
 # modifications like changing the central radius `r0`, the zero azimuth location
 # `theta0`, and the positive azimuthal direction `thetadir`. It also supports
 # changing gridline locations with `rlocator` and `thetalocator` (analogous to
-# `ylocator` and `xlocator` used by `~proplot.axes.CartesianAxes.format`) and
+# `ylocator` and `xlocator` used by `proplot.axes.CartesianAxes.format`) and
 # turning your polar plot into an "annular" or "sector" plot by changing the radial
 # limits `rlim` or the azimuthal limits `thetalim`. Finally, since
 # `proplot.axes.PolarAxes.format` calls `proplot.axes.Axes.format`, it can be used to

proplot/axes/base.py

@@ -1002,7 +1002,7 @@ def format(
         ---------
         The `abc`, `abcstyle`, `abcloc`, `titleloc`, `titleabove`, `titlepad`,
         `abctitlepad`, `leftlabelpad`, `toplabelpad`, `rightlabelpad`, and
-        `bottomlabelpad` keywords and are :ref:`configuration settings <ug_config>`.
+        `bottomlabelpad` keywords are :ref:`configuration settings <ug_config>`.
         We explicitly document these arguments here because it is very common to change
         them. But many :ref:`other configuration settings <ug_format>` can be passed
         to ``format`` too.