From c360bf6f1220171f35d5d76cf0c4560efcff4c5d Mon Sep 17 00:00:00 2001 From: domna Date: Fri, 15 Sep 2023 11:29:30 +0200 Subject: [PATCH] Updates documentation for --undocumented --- pynxtools/dataconverter/README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/pynxtools/dataconverter/README.md b/pynxtools/dataconverter/README.md index 617c2de1f..2bee8f2dd 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 fields which are + undocumented --help Show this message and exit. ```