From cc885692662df0e7c92e23e42fc86ace4684eefd Mon Sep 17 00:00:00 2001 From: Armaan Bhojwani Date: Sat, 13 Feb 2021 19:27:13 -0500 Subject: [PATCH] Make optional arguments more explicit --- lightcards/runner.py | 8 ++++---- man/lightcards.1 | 2 +- man/lightcards.1.md | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/lightcards/runner.py b/lightcards/runner.py index 852bf5b..95e44b5 100644 --- a/lightcards/runner.py +++ b/lightcards/runner.py @@ -20,7 +20,7 @@ def parse_args(): parser.add_argument( "-c", "--config", - metavar="path", + metavar="config_file", type=str, default="/dev/null", help="specify custom config file", @@ -28,12 +28,12 @@ def parse_args(): parser.add_argument( "-V", "--view", - metavar="view", + metavar="1-3", type=int, choices=range(1, 4), help="specify which view to start in", ) - parser.add_argument("inp", metavar="input file", type=str, nargs=1) + parser.add_argument("inp", metavar="input_file", type=str, nargs=1) parser.add_argument( "-a", "--alphabetize", @@ -44,7 +44,7 @@ def parse_args(): "-p", "--purge", action="store_true", - help="don't check cached info before starting", + help="delete cache before starting", ) parser.add_argument( "-r", "--reverse", action="store_true", help="reverse card order" diff --git a/man/lightcards.1 b/man/lightcards.1 index debd9ac..526d82c 100644 --- a/man/lightcards.1 +++ b/man/lightcards.1 @@ -38,7 +38,7 @@ Shuffle card order \f[B]-V\f[R] [1-3], \f[B]--view\f[R] [1-3] Specify startup view .TP -\f[B]-c\f[R], \f[B]--config\f[R] +\f[B]-c\f[R] [config file], \f[B]--config\f[R] [config file] Specify a custom config file .SH KEYS .TP diff --git a/man/lightcards.1.md b/man/lightcards.1.md index 0c5441c..24e3cd0 100644 --- a/man/lightcards.1.md +++ b/man/lightcards.1.md @@ -39,7 +39,7 @@ lightcards \[options\] \[input file\] **-V** \[1-3\], **\--view** \[1-3\] : Specify startup view -**-c**, **\--config** +**-c** \[config file\], **\--config** \[config file\] : Specify a custom config file # KEYS -- 2.39.2