Better formulation for undocumented flag doc

FAIRmat-NFDI · Sep 15, 2023 · f324be3 · f324be3
1 parent c360bf6
commit f324be3
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 4 deletions.
diff --git a/pynxtools/dataconverter/README.md b/pynxtools/dataconverter/README.md
@@ -15,7 +15,6 @@ user@box:~$ pip install git+https://github.com/FAIRmat-NFDI/pynxtools.git
 Converts experimental data to NeXus/HDF5 files based on any provided NXDL.
 
 ```console
-user@box:~$ dataconverter --help
 Usage: dataconverter [OPTIONS]
 
   The CLI entrypoint for the convert function
@@ -35,8 +34,8 @@ Options:
                                   checking the documentation.
   --params-file FILENAME          Allows to pass a .yaml file with all the
                                   parameters the converter supports.
-  --undocumented                  Shows a log output for all fields which are
-                                  undocumented
+  --undocumented                  Shows a log output for all undocumented
+                                  fields
   --help                          Show this message and exit.
 ```
 

diff --git a/pynxtools/dataconverter/convert.py b/pynxtools/dataconverter/convert.py
@@ -190,7 +190,7 @@ def parse_params_file(params_file):
     '--undocumented',
     is_flag=True,
     default=False,
-    help='Shows a log output for all fields which are undocumented'
+    help='Shows a log output for all undocumented fields'
 )
 # pylint: disable=too-many-arguments
 def convert_cli(input_file: Tuple[str],