Skip to content

Commit 4d5f664

Browse files
authored
chore(cli): change metavar for some options (#61)
This changes some metavars such that `--help` output is closer to the Sphinx documentation.
1 parent cb6a5bb commit 4d5f664

File tree

2 files changed

+5
-0
lines changed

2 files changed

+5
-0
lines changed

manim_slides/commons.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ def config_path_option(function: Callable) -> Callable:
1313
"-c",
1414
"--config",
1515
"config_path",
16+
metavar="FILE",
1617
default=CONFIG_PATH,
1718
type=click.Path(dir_okay=False),
1819
help="Set path to configuration file.",

manim_slides/present.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -634,6 +634,7 @@ def convert_cv_qt(self, cv_img):
634634
@click.command()
635635
@click.option(
636636
"--folder",
637+
metavar="DIRECTORY",
637638
default=FOLDER_PATH,
638639
type=click.Path(exists=True, file_okay=False),
639640
help="Set slides folder.",
@@ -674,6 +675,7 @@ def _list_scenes(folder) -> List[str]:
674675
@config_path_option
675676
@click.option(
676677
"--folder",
678+
metavar="DIRECTORY",
677679
default=FOLDER_PATH,
678680
type=click.Path(exists=True, file_okay=False),
679681
help="Set slides folder.",
@@ -690,6 +692,7 @@ def _list_scenes(folder) -> List[str]:
690692
@click.option(
691693
"-r",
692694
"--resolution",
695+
metavar="<WIDTH HEIGHT>",
693696
type=(int, int),
694697
default=(1920, 1080),
695698
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]:
699702
"--to",
700703
"--record-to",
701704
"record_to",
705+
metavar="FILE",
702706
type=click.Path(dir_okay=False),
703707
default=None,
704708
help="If set, the presentation will be recorded into a AVI video file with given name.",

0 commit comments

Comments
 (0)