Minor docs cleanup, update inlinefmt references

lukelbd · lukelbd · commit 2bc9a03fd703 · 2022-03-26T13:12:54.000-06:00
diff --git a/docs/basics.py b/docs/basics.py
@@ -49,7 +49,7 @@
 #    <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 appearance of figures in Jupyter notebooks
-#    using the new :rcraw:`inlinefmt` setting, which is passed to
+#    using the new :rcraw:`inlineformat` setting, which is passed to
 #    `~proplot.config.config_inline_backend` on import. This
 #    imposes a higher-quality default `"inline" format
 #    <https://ipython.readthedocs.io/en/stable/interactive/plotting.html>`__
@@ -155,8 +155,8 @@
     suptitle='Simple subplot grid', title='Title',
     xlabel='x axis', ylabel='y axis'
 )
-# fig.save('example1.png')  # save the figure
-# fig.savefig('example1.png')  # alternative
+# fig.save('~/example1.png')  # save the figure
+# fig.savefig('~/example1.png')  # alternative
 
 
 # %%
@@ -176,8 +176,8 @@
     xlabel='xlabel', ylabel='ylabel'
 )
 axs[2].plot(data, lw=2)
-# fig.save('example2.png')  # save the figure
-# fig.savefig('example2.png')  # alternative
+# fig.save('~/example2.png')  # save the figure
+# fig.savefig('~/example2.png')  # alternative
 
 
 # %%
@@ -198,8 +198,8 @@
     xlabel='xlabel', ylabel='ylabel', abc=True
 )
 axs[0].plot(data, lw=2)
-# fig.save('example3.png')  # save the figure
-# fig.savefig('example3.png')  # alternative
+# fig.save('~/example3.png')  # save the figure
+# fig.savefig('~/example3.png')  # alternative
 
 # %%
 # Using a GridSpec
@@ -217,8 +217,8 @@
     suptitle='Subplot grid with a GridSpec',
     xlabel='xlabel', ylabel='ylabel', abc=True
 )
-# fig.save('example4.png')  # save the figure
-# fig.savefig('example4.png')  # alternative
+# fig.save('~/example4.png')  # save the figure
+# fig.savefig('~/example4.png')  # alternative
 
 # %% [raw] raw_mimetype="text/restructuredtext"
 # .. _ug_subplotgrid:
diff --git a/proplot/__init__.py b/proplot/__init__.py
@@ -10,7 +10,8 @@
 except pkg.DistributionNotFound:
     version = __version__ = 'unknown'
 
-# Import optional dependencies now to isolate import times
+# Import dependencies early to isolate import times
+from . import internals, externals, tests  # noqa: F401
 from .internals.benchmarks import _benchmark
 with _benchmark('pyplot'):
     from matplotlib import pyplot  # noqa: F401
diff --git a/proplot/config.py b/proplot/config.py
@@ -367,17 +367,17 @@ def config_inline_backend(fmt=None):
 
     .. code-block:: ipython
 
-        %config InlineBackend.figure_formats = rc['inlinefmt']
+        %config InlineBackend.figure_formats = rc['inlineformat']
         %config InlineBackend.rc = {}  # never override rc settings
         %config InlineBackend.close_figures = True  # cells start with no active figures
         %config InlineBackend.print_figure_kwargs = {'bbox_inches': None}
 
     When the inline backend is inactive or unavailable, this has no effect.
-    This function is called when you modify the :rcraw:`inlinefmt` property.
+    This function is called when you modify the :rcraw:`inlineformat` property.
 
     Parameters
     ----------
-    fmt : str or sequence, default: :rc:`inlinefmt`
+    fmt : str or sequence, default: :rc:`inlineformat`
         The inline backend file format or a list thereof. Valid formats
         include ``'jpg'``, ``'png'``, ``'svg'``, ``'pdf'``, and ``'retina'``.
 
@@ -389,7 +389,7 @@ def config_inline_backend(fmt=None):
     ipython = get_ipython()
     if ipython is None:
         return
-    fmt = _not_none(fmt, rc_proplot['inlinefmt'])
+    fmt = _not_none(fmt, rc_proplot['inlineformat'])
     if isinstance(fmt, str):
         fmt = [fmt]
     elif np.iterable(fmt):
@@ -942,7 +942,7 @@ def _get_item_dicts(self, key, value, skip_cycle=False):
                     raise KeyError(f'Invalid rc setting {key!r}.')
 
         # Special key: configure inline backend
-        if contains('inlinefmt'):
+        if contains('inlineformat'):
             config_inline_backend(value)
 
         # Special key: apply stylesheet
diff --git a/proplot/gridspec.py b/proplot/gridspec.py
@@ -77,7 +77,7 @@
 wequal, hequal, equal :  bool, default: :rc:`subplots.equalspace`
     Whether to make the tight layout algorithm apply equal spacing
     between columns, rows, or both.
-wgroup, hgroup, group :  bool, default: :rc:`subplot.groupspace`
+wgroup, hgroup, group :  bool, default: :rc:`subplots.groupspace`
     Whether to make the tight layout algorithm just consider spaces between
     adjacent subplots instead of entire columns and rows of subplots.
 outerpad : unit-spec, default: :rc:`subplots.outerpad`
diff --git a/proplot/internals/__init__.py b/proplot/internals/__init__.py
@@ -335,7 +335,7 @@ def _pop_props(input, *categories, prefix=None, ignore=None, skip=None):
             if any(string in key for string in ignore):
                 warnings._warn_proplot(f'Ignoring property {key}={prop!r}.')
                 continue
-            if isinstance(prop, str):
+            if isinstance(prop, str):  # ad-hoc unit conversion
                 if key in ('fontsize',):
                     from ..utils import _fontsize_to_pt
                     prop = _fontsize_to_pt(prop)
diff --git a/proplot/internals/rcsetup.py b/proplot/internals/rcsetup.py
@@ -1115,8 +1115,8 @@ def copy(self):
         _validate_int,
         'Native `~matplotlib.colors.ListedColormap`\\ s with more colors than '
         'this are converted to `~proplot.colors.ContinuousColormap` rather than '
-        '`~proplot.colors.DiscreteColormap`. This helps translate perceptually '
-        'uniform colormaps from other projects registered as ListedColormap.'
+        '`~proplot.colors.DiscreteColormap`. This helps translate continuous '
+        'colormaps from external projects.'
     ),
     'cmap.lut': (
         256,
