Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updates documentation for --undocumented #160

Merged
merged 3 commits into from
Sep 18, 2023
Merged

Updates documentation for --undocumented #160

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c360bf6
Updates documentation for --undocumented
domna Sep 15, 2023
f324be3
Better formulation for undocumented flag doc
domna Sep 15, 2023
121f72e
Restore command listing in dataconverter README
domna Sep 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion pynxtools/dataconverter/README.md
View file
Open in desktop
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 undocumented
fields
--help Show this message and exit.
```

Expand Down
2 changes: 1 addition & 1 deletion pynxtools/dataconverter/convert.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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],
Expand Down
Loading