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.

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

Suboptimal help string for parameter "--mets" #263

Closed
wrznr opened this issue Jul 17, 2019 · 0 comments
Closed

Suboptimal help string for parameter "--mets" #263

wrznr opened this issue Jul 17, 2019 · 0 comments

Comments

@wrznr
Copy link
Contributor

wrznr commented Jul 17, 2019

Running an arbitrary ocrd processor with --help returns

$ ocrd-tesserocr-binarize --help
Usage: ocrd-tesserocr-binarize [OPTIONS]

Options:
  -V, --version                   Show version
  -l, --log-level [OFF|ERROR|WARN|INFO|DEBUG|TRACE]
                                  Log level
  -J, --dump-json                 Dump tool description as JSON and exit
  -p, --parameter PATH
  -g, --page-id TEXT              ID(s) of the pages to process
  -O, --output-file-grp TEXT      File group(s) used as output.
  -I, --input-file-grp TEXT       File group(s) used as input.
  -w, --working-dir TEXT          Working Directory
  -m, --mets TEXT                 METS URL to validate
  --help                          Show this message and exit.

The help string for --mets is not optimal. In addition,

@click.option('-m', '--mets', help="METS to process", required=True)
seems to set a much more reasonable help string.

@kba kba closed this as completed in 77aaee8 Jan 10, 2020
kba added a commit that referenced this issue Jan 10, 2020
fix help string for -m/--mets, fix #263
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants