Updates documentation for --undocumented (#160)

* Updates documentation for --undocumented * Better formulation for undocumented flag doc * Restore command listing in dataconverter README
FAIRmat-NFDI · Sep 18, 2023 · f453d09 · f453d09
1 parent d49f5af
commit f453d09
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/pynxtools/dataconverter/README.md b/pynxtools/dataconverter/README.md
@@ -23,7 +23,7 @@ Usage: dataconverter [OPTIONS]
 Options:
   --input-file TEXT               The path to the input data file to read.
                                   (Repeat for more than one file.)
-  --reader [apm|ellips|em_nion|em_spctrscpy|example|hall|json_map|json_yml|mpes|rii_database|transmission|xps]
+  --reader [apm|ellips|em_nion|em_om|em_spctrscpy|example|hall|json_map|json_yml|mpes|rii_database|sts|transmission|xps]
                                   The reader to use. default="example"
   --nxdl TEXT                     The name of the NXDL file to use without
                                   extension.
@@ -35,6 +35,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 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],