chore: Improve cli option help texts

Fixed the write option text to be without wrong negation.
Show default settings for flag options.
This commit is contained in:
Marty Oehme 2024-01-23 09:27:02 +01:00
parent a51205954c
commit 2880c06f53
Signed by: Marty
GPG key ID: EDBF2ED917B2EF6A

View file

@ -35,12 +35,14 @@ papis.config.register_default_settings(DEFAULT_OPTIONS)
@click.option( @click.option(
"--write/--no-write", "--write/--no-write",
"-w", "-w",
help="Do not write annotations to notes only print results to stdout.", help="Write extracted annotations into papis notes.",
show_default=True,
) )
@click.option( @click.option(
"--manual/--no-manual", "--manual/--no-manual",
"-m", "-m",
help="Open note in editor for manual editing after annotation extraction.", help="Open note in editor for manual editing after annotation extraction.",
show_default=True,
) )
@click.option( @click.option(
"--template", "--template",
@ -50,6 +52,7 @@ papis.config.register_default_settings(DEFAULT_OPTIONS)
case_sensitive=False, case_sensitive=False,
), ),
help="Choose an output template to format annotations with.", help="Choose an output template to format annotations with.",
show_default=True,
) )
@click.option( @click.option(
"--extractor", "--extractor",
@ -61,12 +64,13 @@ papis.config.register_default_settings(DEFAULT_OPTIONS)
), ),
default=list(all_extractors.keys()), default=list(all_extractors.keys()),
multiple=True, multiple=True,
help="Choose an extractor to apply to the selected documents.", help="Choose an extractor to apply to the selected documents. [default: all]",
) )
@click.option( @click.option(
"--force/--no-force", "--force/--no-force",
"-f", "-f",
help="Do not drop any annotations because they already exist.", help="Do not drop any annotations because they already exist.",
show_default=True,
) )
def main( def main(
query: str, query: str,