Skip to content

Commit 40cb992

Browse files
committed
Quickstart
1 parent aa75b9b commit 40cb992

1 file changed

Lines changed: 13 additions & 12 deletions

File tree

docs/quickstart6.rst

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,13 @@ Plot command wrappers
22
=====================
33

44
New features have been added to various matplotlib plotting commands
5-
thanks to a set of wrapper functions (see the `~proplot.axes`
6-
documentation). These features are a strict *superset* of the existing
7-
matplotlib API – if you want, you can use plotting commands exactly as
8-
you always have. This section documents the variety of wrapper
9-
functions. You should also see the :ref:`On-the-fly colormaps` and
5+
thanks to a set of wrapper functions. These features are a strict
6+
*superset* of the existing matplotlib API – if you want, you can use
7+
plotting commands exactly as you always have. This section documents
8+
these wrapper functions. For details, see the `~proplot.axes`
9+
documentation.
10+
11+
You should also see the :ref:`On-the-fly colormaps` and
1012
:ref:`On-the-fly color cycles` sections, which explain how
1113
`~proplot.wrappers.cmap_wrapper` and
1214
`~proplot.wrappers.cycle_wrapper` can be used to apply new colormaps
@@ -17,13 +19,12 @@ Colormap normalizers
1719

1820
`~proplot.wrappers.cmap_wrapper` assigns the
1921
`~proplot.colortools.BinNorm` “meta-normalizer” as the data normalizer
20-
for all colormap plots. This allows for discrete levels in all
21-
situations – that is, `~matplotlib.axes.Axes.pcolor` and
22-
`~matplotlib.axes.Axes.pcolormesh` now accept a ``levels`` keyword
23-
arg, just like `~matplotlib.axes.Axes.contourf`.
24-
`~proplot.colortools.BinNorm` also ensures the colorbar colors span
25-
the entire colormap range, and that “cyclic” colorbar colors are
26-
distinct on each end.
22+
for all plotting commands involving colormaps. This permits discrete
23+
``levels`` even for commands like `~matplotlib.axes.Axes.pcolor` and
24+
`~matplotlib.axes.Axes.pcolormesh`. `~proplot.colortools.BinNorm`
25+
also ensures that colorbar colors span the entire colormap range, no
26+
matter the ``extend`` setting, and that “cyclic” colormap colors are
27+
distinct on each end of the colorbar.
2728

2829
`~proplot.wrappers.cmap_wrapper` also fixes the well-documented
2930
`white-lines-between-filled-contours <https://stackoverflow.com/q/8263769/4970632>`__

0 commit comments

Comments
 (0)