Skip to content

Commit 09f2058

Browse files
committed
Add instructions to help users disable 'autoformat'
1 parent c9ca0bd commit 09f2058

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

docs/usage.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,8 @@ plotting packages.
119119
works just like the native `xarray.DataArray.plot` and
120120
`pandas.DataFrame.plot` methods. A demonstration of this feature is given
121121
in the sections on :ref:`1D plotting <ug_1dintegration>` and
122-
:ref:`2D plotting <ug_2dintegration>`.
122+
:ref:`2D plotting <ug_2dintegration>`. This feature can be disabled by
123+
setting :rcraw:`autoformat` to ``False``.
123124
* The `~proplot.axes.GeoAxes` class uses the `cartopy` or
124125
`~mpl_toolkits.basemap` packages to :ref:`plot geophysical data <ug_geoplot>`,
125126
:ref:`add geographic features <ug_geoformat>`, and

docs/why.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -462,9 +462,8 @@ ProPlot reproduces many of the `xarray.DataArray.plot`,
462462
`~proplot.axes.Axes` plotting methods themselves. Passing a
463463
`~xarray.DataArray`, `~pandas.DataFrame`, or `~pandas.Series` through any
464464
plotting method automatically updates the axis tick labels, axis labels,
465-
subplot titles, and colorbar and legend labels from the metadata. This can
466-
be disabled by passing ``autoformat=False`` to the plotting method or to
467-
`~proplot.ui.subplots`.
465+
subplot titles, and colorbar and legend labels from the metadata. This
466+
feature can be disabled by setting :rcraw:`autoformat` to ``False``.
468467

469468
Also, as described in the section on :ref:`plotting methods <why_plotting>`,
470469
ProPlot implements certain features like grouped bar plots, layered area

0 commit comments

Comments
 (0)