Skip to content

Commit

Permalink
Updates documentation for --undocumented
Browse files Browse the repository at this point in the history
  • Loading branch information
domna committed Sep 15, 2023
1 parent debd5cb commit c360bf6
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion pynxtools/dataconverter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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.
```

Expand Down

0 comments on commit c360bf6

Please sign in to comment.