From 7a6607aceeae9ca269c2e911916a2878487c4c70 Mon Sep 17 00:00:00 2001
From: Jerome Carnis <jerome.carnis@desy.de>
Date: Fri, 18 Mar 2022 08:24:34 +0100
Subject: [PATCH] include new modules in the doc

---
 bcdi/utils/parameters.py    |  5 +++--
 bcdi/utils/parser.py        |  2 +-
 doc/modules/utils/index.rst | 33 +++++++++++++++++++++++++++++++++
 3 files changed, 37 insertions(+), 3 deletions(-)

diff --git a/bcdi/utils/parameters.py b/bcdi/utils/parameters.py
index 2cd643e9c..9df52b1e5 100644
--- a/bcdi/utils/parameters.py
+++ b/bcdi/utils/parameters.py
@@ -7,9 +7,10 @@
 #         Jerome Carnis, carnis_jerome@yahoo.fr
 
 """
-Definition of the correct parameters for the config files.
+Validation of configuration parameters.
 
-Parameter validation is performed over the excepted parameters.
+The validation is performed only on the expected parameters. Other parameters are simply
+discarded.
 """
 from numbers import Number, Real
 import numpy as np
diff --git a/bcdi/utils/parser.py b/bcdi/utils/parser.py
index 7d07d0cf8..47bf29a4a 100644
--- a/bcdi/utils/parser.py
+++ b/bcdi/utils/parser.py
@@ -164,7 +164,7 @@ class ConfigParser:
     file. Some validation is also realized in the class.
 
     :param file_path: path of the configuration file that contains
-    the arguments, str.
+     the arguments, str.
     :param command_line_args: an optional dictionary of command-line arguments
     """
 
diff --git a/doc/modules/utils/index.rst b/doc/modules/utils/index.rst
index d42722ebc..46614d886 100644
--- a/doc/modules/utils/index.rst
+++ b/doc/modules/utils/index.rst
@@ -30,6 +30,39 @@ API Reference
 .. automodule:: bcdi.utils.image_registration
    :members:
 
+io_helper
+^^^^^^^^^
+
+Class and decorators related to the safe opening of files.
+
+API Reference
+-------------
+
+.. automodule:: bcdi.utils.io_helper
+   :members:
+
+parameters
+^^^^^^^^^^
+
+Function related to the validation of configuration parameters.
+
+API Reference
+-------------
+
+.. automodule:: bcdi.utils.parameters
+   :members:
+
+parser
+^^^^^^
+
+Class and functions related to loading of the config file and command line parameters.
+
+API Reference
+-------------
+
+.. automodule:: bcdi.utils.parser
+   :members:
+
 validation
 ^^^^^^^^^^