Merge pull request #150 from lukelbd/rename-show

Rename 'show' module to 'demos' to fix name conflict

Author: lukelbd

docs/api.rst

@@ -61,9 +61,9 @@ Plotting wrappers
 Show functions
 ==============
 
-.. automodule:: proplot.show
+.. automodule:: proplot.demos
 
-.. automodsumm:: proplot.show
+.. automodsumm:: proplot.demos
    :toctree: api
 
 

docs/colormaps.py

@@ -42,7 +42,7 @@
 # `~proplot.colors.PerceptuallyUniformColormap` colormaps (see
 # :ref:`perceptually uniform colormaps <ug_perceptual>`) plus several
 # colormaps from other online data viz projects. Use
-# `~proplot.show.show_cmaps` to generate a table of registered maps. The
+# `~proplot.demos.show_cmaps` to generate a table of registered maps. The
 # figure is broken down into the following sections:
 #
 # * "User" colormaps, i.e. colormaps saved to your ``~/.proplot/cmaps``
@@ -103,9 +103,9 @@
 #
 # The colorspace used by each `~proplot.colors.PerceptuallyUniformColormap`
 # is set with the `space` keyword arg. To plot arbitrary cross-sections of
-# these colorspaces, use `~proplot.show.show_colorspaces` (the black
+# these colorspaces, use `~proplot.demos.show_colorspaces` (the black
 # regions represent impossible colors). To see how colormaps vary with
-# respect to each channel, use `~proplot.show.show_channels`. Some examples
+# respect to each channel, use `~proplot.demos.show_channels`. Some examples
 # are shown below.
 #
 # In theory, "uniform" colormaps should have *straight* lines in hue, chroma,

docs/colors.py

@@ -31,7 +31,7 @@
 # ProPlot adds new color names from the `XKCD color survey
 # <https://blog.xkcd.com/2010/05/03/color-survey-results/>`__  and
 # the `Open Color <https://github.com/yeun/open-color>`__ UI design color
-# palettes. You can use `~proplot.show.show_colors` to generate a table of these
+# palettes. You can use `~proplot.demos.show_colors` to generate a table of these
 # colors. Note that the matplotlib's native `X11 named colors
 # <https://matplotlib.org/examples/color/named_colors.html>`__ are still
 # registered, but some of the X11 color names may be overwritten by the XKCD names,
@@ -43,7 +43,7 @@
 # ProPlot filters the available XKCD colors so that they are *sufficiently
 # distinct* in the :ref:`perceptually uniform colorspace <ug_perceptual>`.
 # This makes it a bit easier to pick out colors from the table generated with
-# `~proplot.show.show_colors`. Similar names were also cleaned up -- for
+# `~proplot.demos.show_colors`. Similar names were also cleaned up -- for
 # example, ``'reddish'`` and ``'reddy'`` are changed to ``'red'``.
 
 # %%

docs/cycles.py

@@ -39,7 +39,7 @@
 # Included color cycles
 # ---------------------
 #
-# Use `~proplot.show.show_cycles` to generate a table of the color cycles
+# Use `~proplot.demos.show_cycles` to generate a table of the color cycles
 # registered by default and loaded from your ``~/.proplot/cycles`` folder.
 # You can make your own color cycles using the `~proplot.constructor.Cycle`
 # constructor function.

docs/fonts.py

@@ -63,7 +63,7 @@
 # lists for each font family are shown in the
 # :ref:`default proplotrc file <ug_proplotrc>`.
 #
-# To compare different fonts, use the `~proplot.show.show_fonts` command. By
+# To compare different fonts, use the `~proplot.demos.show_fonts` command. By
 # default, this displays the *sans serif* fonts available on your system and
 # packaged with ProPlot. The default table on a sparse Linux server is shown
 # below. The "¤" symbol appears where characters for a particular font are

docs/usage.rst

@@ -140,9 +140,9 @@ ProPlot includes several useful constructor functions and subclasses.
   colormap classes and add several methods. The new
   `~proplot.colors.PerceptuallyUniformColormap` class is used to make
   colormaps with :ref:`perceptually uniform transitions <ug_perceptual>`.
-* The `~proplot.show.show_cmaps`, `~proplot.show.show_cycles`,
-  `~proplot.show.show_colors`, `~proplot.show.show_fonts`,
-  `~proplot.show.show_channels`, and `~~proplot.show.show_colorspaces`
+* The `~proplot.demos.show_cmaps`, `~proplot.demos.show_cycles`,
+  `~proplot.demos.show_colors`, `~proplot.demos.show_fonts`,
+  `~proplot.demos.show_channels`, and `~proplot.demos.show_colorspaces`
   functions are used to visualize your :ref:`color scheme <ug_colors>`
   and :ref:`font options <ug_fonts>` and
   :ref:`inspect individual colormaps <ug_perceptual>`.

proplot/__init__.py

@@ -19,7 +19,7 @@
     from .axes import *  # noqa: F401 F403
     from .figure import *  # noqa: F401 F403
     from .ui import *  # noqa: F401 F403
-    from .show import *  # noqa: F401 F403
+    from .demos import *  # noqa: F401 F403
 
 # SCM versioning
 name = 'proplot'

proplot/config.py

@@ -1202,7 +1202,7 @@ def register_cmaps(user=True, default=False):
 
     %(register.ext_table)s
 
-    To visualize the registered colormaps, use `~proplot.show.show_cmaps`.
+    To visualize the registered colormaps, use `~proplot.demos.show_cmaps`.
 
     Parameters
     ----------
@@ -1230,7 +1230,7 @@ def register_cycles(user=True, default=False):
 
     %(register.ext_table)s
 
-    To visualize the registered color cycles, use `~proplot.show.show_cycles`.
+    To visualize the registered color cycles, use `~proplot.demos.show_cycles`.
 
     Parameters
     ----------
@@ -1255,7 +1255,7 @@ def register_colors(user=True, default=False, space='hcl', margin=0.10):
     ``.txt`` files saved in ``~/.proplot/colors``. Each file should contain
     one line per color in the format ``name : hex``. Whitespace is ignored.
 
-    To visualize the registered colors, use `~proplot.show.show_colors`.
+    To visualize the registered colors, use `~proplot.demos.show_colors`.
 
     Parameters
     ----------
@@ -1370,7 +1370,7 @@ def register_fonts():
     for a guide on converting various other font file types to ``.ttf`` and
     ``.otf`` for use with matplotlib.
 
-    To visualize the registered fonts, use `~proplot.show.show_fonts`.
+    To visualize the registered fonts, use `~proplot.demos.show_fonts`.
     """
     # Find proplot fonts
     # WARNING: If you include a font file with an unrecognized style,

proplot/show.py proplot/demos.pyproplot/show.py renamed to proplot/demos.py

@@ -1910,7 +1910,7 @@ def _build_discrete_norm(
     minlength=2,
 ):
     """
-    Build a `~proplot.pcolors.DiscreteNorm` or `~proplot.pcolors.BoundaryNorm`
+    Build a `~proplot.colors.DiscreteNorm` or `~proplot.colors.BoundaryNorm`
     from the input arguments. This automatically calculates "nice" level
     boundaries if they were not provided.
 
@@ -2122,7 +2122,7 @@ def cmap_changer(
 ):
     """
     Adds several new keyword args and features for specifying the colormap,
-    levels, and normalizers. Uses the `~proplot.pcolors.DiscreteNorm`
+    levels, and normalizers. Uses the `~proplot.colors.DiscreteNorm`
     normalizer to bin data into discrete color levels (see notes).
 
     Note
@@ -2139,7 +2139,7 @@ def cmap_changer(
         Passed to `~proplot.constructor.Colormap`.
     norm : normalizer spec, optional
         The colormap normalizer, used to warp data before passing it
-        to `~proplot.pcolors.DiscreteNorm`. This is passed to the
+        to `~proplot.colors.DiscreteNorm`. This is passed to the
         `~proplot.constructor.Norm` constructor.
     norm_kw : dict-like, optional
         Passed to `~proplot.constructor.Norm`.
@@ -2240,11 +2240,11 @@ def cmap_changer(
     standardize_2d
     proplot.constructor.Colormap
     proplot.constructor.Norm
-    proplot.pcolors.DiscreteNorm
+    proplot.colors.DiscreteNorm
 
     Note
     ----
-    The `~proplot.pcolors.DiscreteNorm` normalizer, used with all colormap
+    The `~proplot.colors.DiscreteNorm` normalizer, used with all colormap
     plots, makes sure that your levels always span the full range of colors
     in the colormap, whether `extend` is set to ``'min'``, ``'max'``,
     ``'neither'``, or ``'both'``. By default, when `extend` is not ``'both'``,