From f453d09d69b2d6d45f57bf566ab52ba8e1a52286 Mon Sep 17 00:00:00 2001 From: Florian Dobener Date: Mon, 18 Sep 2023 16:29:00 +0200 Subject: [PATCH] Updates documentation for --undocumented (#160) * Updates documentation for --undocumented * Better formulation for undocumented flag doc * Restore command listing in dataconverter README --- pynxtools/dataconverter/README.md | 4 +++- pynxtools/dataconverter/convert.py | 2 +- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/pynxtools/dataconverter/README.md b/pynxtools/dataconverter/README.md index 617c2de1f..937dabb1a 100644 --- 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 index 618970304..29ca21b6e 100644 --- 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],