Skip to content

Commit eb1446f

Browse files
committed
Update configuration docs
1 parent e3fbbab commit eb1446f

File tree

1 file changed

+9
-11
lines changed

1 file changed

+9
-11
lines changed

docs/configuration.rst

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,23 +7,23 @@ Overview
77
A special object named `~proplot.rctools.rc`, belonging to the
88
`~proplot.rctools.rc_configurator` class, is created on import.
99
This is your one-stop shop for changing global settings belonging to any of
10-
the following three categories.
10+
the following three categories:
1111

1212
1. Builtin matplotlib `rcParams <https://matplotlib.org/users/customizing.html>`__
1313
settings. These have the format ``x.y`` or ``x.y.z``.
1414
2. ProPlot :ref:`rcParamsLong` settings. These also have the format ``x.y``
1515
(see below).
1616
3. ProPlot :ref:`rcParamsShort` settings. These have no dots (see below).
1717

18-
You can change settings with the `~proplot.rctools.rc` object as follows.
18+
You can change settings with the `~proplot.rctools.rc` object as follows:
1919

2020
* ``plot.rc.name = value``
2121
* ``plot.rc['name'] = value``
2222
* ``plot.rc.update(name1=value1, name2=value2)``
2323
* ``plot.rc.update({'name1':value1, 'name2':value2})``
2424

2525
To temporarily change settings on a particular axes, use either of the
26-
following.
26+
following:
2727

2828
* ``ax.format(name=value)``
2929
* ``ax.format(rc_kw={'name':value})``
@@ -102,8 +102,8 @@ There are two new additions to the ``image`` category, and the new
102102
`~proplot.axes.Axes.colorbar` properties.
103103
The new ``gridminor`` category controls minor gridline settings,
104104
and the new ``geogrid`` category controls meridian and parallel line settings
105-
for `~proplot.axes.ProjAxes`. For both ``gridminor`` and ``geogrid``, if
106-
a property is empty, the corresponding property from ``grid`` is used.
105+
for `~proplot.axes.ProjAxes`. Note that when a ``grid`` property is changed,
106+
it also changed the corresponding ``gridminor`` property.
107107

108108
Finally, the ``geoaxes``, ``land``, ``ocean``, ``rivers``, ``lakes``,
109109
``borders``, and ``innerborders`` categories control various
@@ -195,11 +195,9 @@ To modify the global settings, edit your
195195
``~/.proplotrc`` file. To modify settings for a particular project,
196196
create a ``.proplotrc`` file in the same directory as your ipython
197197
notebook, or in an arbitrary parent directory.
198+
As an example, a ``.proplotrc`` file containing the default settings
199+
is shown below. The syntax is mostly the same as the syntax used for
200+
`matplotlibrc files <https://matplotlib.org/3.1.1/tutorials/introductory/customizing.html#customizing-with-matplotlibrc-files>`__.
198201

199-
As an example, the default ``.proplotrc`` file
200-
is shown below. The syntax is roughly the same as that used for
201-
``matplotlibrc`` files, although ``.proplotrc`` strictly adheres to
202-
`YAML <https://en.wikipedia.org/wiki/YAML>`__.
203-
204-
.. include:: ../proplot/.proplotrc
202+
.. include:: _static/proplotrc
205203
:literal:

0 commit comments

Comments
 (0)