Make optional arguments more explicit

diff --git a/lightcards/runner.py b/lightcards/runner.py
index 852bf5bf64b8c921e832aae4541554b87fc48f67..95e44b5275443b3f25941413123c68e1577e5344 100644 (file)
--- a/lightcards/runner.py
+++ b/lightcards/runner.py
@@ -20,7 +20,7 @@ def parse_args():
     parser.add_argument(
         "-c",
         "--config",
     parser.add_argument(
         "-c",
         "--config",

-        metavar="path",
+        metavar="config_file",

         type=str,
         default="/dev/null",
         help="specify custom config file",
         type=str,
         default="/dev/null",
         help="specify custom config file",


@@ -28,12 +28,12 @@ def parse_args():
     parser.add_argument(
         "-V",
         "--view",
     parser.add_argument(
         "-V",
         "--view",

-        metavar="view",
+        metavar="1-3",

         type=int,
         choices=range(1, 4),
         help="specify which view to start in",
     )
         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",
     parser.add_argument(
         "-a",
         "--alphabetize",


@@ -44,7 +44,7 @@ def parse_args():
         "-p",
         "--purge",
         action="store_true",
         "-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"
     )
     parser.add_argument(
         "-r", "--reverse", action="store_true", help="reverse card order"

diff --git a/man/lightcards.1 b/man/lightcards.1
index debd9ac1c9ac80e99f6bb38d9546563d65ad0f9c..526d82cbbb96fe961d18cf41094d644f90fe1fec 100644 (file)
--- 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]-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
 Specify a custom config file
 .SH KEYS
 .TP

diff --git a/man/lightcards.1.md b/man/lightcards.1.md
index 0c5441ca52222be8e84abc56eb275b481a194a76..24e3cd0129b179d63ac6da26f805333eb8b60cee 100644 (file)
--- 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
 
 **-V** \[1-3\], **\--view** \[1-3\]
 : Specify startup view
 

-**-c**, **\--config**
+**-c** \[config file\], **\--config** \[config file\]

 : Specify a custom config file
 
 # KEYS
 : Specify a custom config file
 
 # KEYS