Skip to content

Commit

Permalink
DOC: Fix formatting of config file keys.
Browse files Browse the repository at this point in the history
The continued lines are indented too much causing weird wrapping.
Change to a definition list format instead of a bullet list.
  • Loading branch information
QuLogic committed May 19, 2017
1 parent 734485f commit 10c0003
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 40 deletions.
41 changes: 21 additions & 20 deletions docs/source/cartopy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,23 +27,24 @@ The top level cartopy module contains the :attr:`~cartopy.config` dictionary whi

Keys in the config dictionary:

* ``pre_existing_data_dir`` - the absolute path to a directory where standard
data (such as that from NaturalEarth) can be
found. If it is not found in this location
the ``data_dir`` config item will be used.

* ``data_dir`` - the absolute path to a directory where standard data (such
as that from NaturalEarth) can be found. If it is not found
and the item is downloadable cartopy will download the
appropriate file(s) to a subdirectory of this directory,
therefore ``data_dir`` should be writable by the user.

* ``repo_data_dir`` - the absolute path to the directory where the data
delivered with the cartopy repository is stored.
Typically this will only be set by OS packagers and
system administrators for site wide deployments.

* ``downloaders`` - a dictionary mapping standard "specifications" to the
appropriate :class:`~cartopy.io.Downloader`. For further
documentation and an example see
:func:`cartopy.io.Downloader.from_config`.
``pre_existing_data_dir``
The absolute path to a directory where standard data (such as that from
NaturalEarth) can be found. If it is not found in this location the
``data_dir`` config item will be used.

``data_dir``
The absolute path to a directory where standard data (such as that from
NaturalEarth) can be found. If it is not found and the item is
downloadable cartopy will download the appropriate file(s) to a
subdirectory of this directory, therefore ``data_dir`` should be
writable by the user.

``repo_data_dir``
The absolute path to the directory where the data delivered with the
cartopy repository is stored. Typically this will only be set by OS
packagers and system administrators for site wide deployments.

``downloaders``
A dictionary mapping standard "specifications" to the appropriate
:class:`~cartopy.io.Downloader`. For further documentation and an
example see :func:`cartopy.io.Downloader.from_config`.
40 changes: 20 additions & 20 deletions lib/cartopy/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -60,26 +60,26 @@
Keys in the config dictionary:
* ``pre_existing_data_dir`` - the absolute path to a directory where standard
data (such as that from NaturalEarth) can be
found. If it is not found in this location
the ``data_dir`` config item will be used.
* ``data_dir`` - the absolute path to a directory where standard data (such
as that from NaturalEarth) can be found. If it is not found
and the item is downloadable cartopy will download the
appropriate file(s) to a subdirectory of this directory,
therefore ``data_dir`` should be writable by the user.
* ``repo_data_dir`` - the absolute path to the directory where the data
delivered with the cartopy repository is stored.
Typically this will only be set by OS packagers and
system administrators for site wide deployments.
* ``downloaders`` - a dictionary mapping standard "specifications" to the
appropriate :class:`~cartopy.io.Downloader`. For further
documentation and an example see
:func:`cartopy.io.Downloader.from_config`.
``pre_existing_data_dir``
The absolute path to a directory where standard data (such as that from
NaturalEarth) can be found. If it is not found in this location the
``data_dir`` config item will be used.
``data_dir``
The absolute path to a directory where standard data (such as that from
NaturalEarth) can be found. If it is not found and the item is downloadable
cartopy will download the appropriate file(s) to a subdirectory of this
directory, therefore ``data_dir`` should be writable by the user.
``repo_data_dir``
The absolute path to the directory where the data delivered with the
cartopy repository is stored. Typically this will only be set by OS
packagers and system administrators for site wide deployments.
``downloaders``
A dictionary mapping standard "specifications" to the appropriate
:class:`~cartopy.io.Downloader`. For further documentation and an example
see :func:`cartopy.io.Downloader.from_config`.
""" # n.b. docstring changes should be propagated to docs/source/cartopy.rst

Expand Down

0 comments on commit 10c0003

Please sign in to comment.