Skip to content

Commit

Permalink
Fix doc
Browse files Browse the repository at this point in the history
  • Loading branch information
stefraynaud committed Jul 18, 2023
1 parent b23f145 commit a89ff24
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 9 deletions.
2 changes: 0 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,6 @@ xoa - xarray-based ocean analysis library
xoa is intended to help reading and manipulating observed
and simulated ocean data.
It is heavily based on `xarray <http://xarray.pydata.org/en/stable/>`_.
For those who know it, it is the successor of
`vacumm <https://github.com/VACUMM/vacumm>`_.

Installation
------------
Expand Down
14 changes: 7 additions & 7 deletions doc/uses.cfgm.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ Config management with :mod:`xoa.cfgm`
Introduction
============

The :mod:`xoa.cfgm` module facilitates and extends the functionality
offered by the excellent
The :mod:`xoa.cfgm` module simplifies and extends the functionality
provided by the excellent
`configobj <https://configobj.readthedocs.io/en/latest/index.html>`_
configuration file reading and validation package.
It makes the global usage slightly easier and adds support for
configuration file reader and validator package.
It makes global usage a little easier and adds support for
plurals forms and for exporting the specifications
to a commandline options and rst declarations.
to commandline options and rst declarations.


Loading and validating
Expand Down Expand Up @@ -45,8 +45,8 @@ Now, initialize the config manager:
CFGM = cfgm.ConfigManager(cfgspecs_lines)
.. note:: To configure a library, the `cfgspecs_lines` argument is typically the name
of a static file placed in the same directory as the module that will
initializes an instance of the `~xoa.cfg.ConfigManager` class.
of a static file placed in the same directory as the module, which will
initialize an instance of the :class:`~xoa.cfg.ConfigManager` class.

And finally, load and validate the user configuration:

Expand Down

0 comments on commit a89ff24

Please sign in to comment.