chore(cli): change metavar for some options (#61)

This changes some metavars such that `--help` output is closer to the Sphinx documentation.
This commit is contained in:
Jérome Eertmans
2022-10-31 09:13:32 +01:00
committed by GitHub
parent cb6a5bb35f
commit 4d5f664348
2 changed files with 5 additions and 0 deletions

View File

@ -13,6 +13,7 @@ def config_path_option(function: Callable) -> Callable:
"-c",
"--config",
"config_path",
metavar="FILE",
default=CONFIG_PATH,
type=click.Path(dir_okay=False),
help="Set path to configuration file.",

View File

@ -634,6 +634,7 @@ class App(QWidget):
@click.command()
@click.option(
"--folder",
metavar="DIRECTORY",
default=FOLDER_PATH,
type=click.Path(exists=True, file_okay=False),
help="Set slides folder.",
@ -674,6 +675,7 @@ def _list_scenes(folder) -> List[str]:
@config_path_option
@click.option(
"--folder",
metavar="DIRECTORY",
default=FOLDER_PATH,
type=click.Path(exists=True, file_okay=False),
help="Set slides folder.",
@ -690,6 +692,7 @@ def _list_scenes(folder) -> List[str]:
@click.option(
"-r",
"--resolution",
metavar="<WIDTH HEIGHT>",
type=(int, int),
default=(1920, 1080),
help="Window resolution WIDTH HEIGHT used if fullscreen is not set. You may manually resize the window afterward.",
@ -699,6 +702,7 @@ def _list_scenes(folder) -> List[str]:
"--to",
"--record-to",
"record_to",
metavar="FILE",
type=click.Path(dir_okay=False),
default=None,
help="If set, the presentation will be recorded into a AVI video file with given name.",