added better help entries to command line parameters

Mon, 24 Jun 2019 00:18:19 +0300

author
Teemu Piippo <teemu@hecknology.net>
date
Mon, 24 Jun 2019 00:18:19 +0300
changeset 81
e65d82501a38
parent 80
2f81758d1537
child 82
75b5241a35ec

added better help entries to command line parameters

ldcheck.py file | annotate | diff | comparison | revisions
--- a/ldcheck.py	Mon Jun 24 00:18:49 2019 +0300
+++ b/ldcheck.py	Mon Jun 24 00:18:19 2019 +0300
@@ -64,7 +64,7 @@
 
 import argparse
 
-class ListTestSuiteAction(argparse.Action):
+class ListProblemsAction(argparse.Action):
     def __init__(self, option_strings, dest, nargs = None, **kwargs):
         super().__init__(option_strings, dest, nargs = 0, **kwargs)
     def __call__(self, *args, **kwargs):
@@ -85,12 +85,23 @@
     parser = argparse.ArgumentParser()
     parser.add_argument('filename')
     parser.add_argument('--list',
-        action = ListTestSuiteAction,
-        help = 'Lists all possible checks and exit',
+        action = ListProblemsAction,
+        help = 'lists all possible problem types and exit',
+    )
+    parser.add_argument('--dump',
+        action = 'store_true',
+        help = 'dumps the internal parsed structure of the part file',
     )
-    parser.add_argument('--dump', action = 'store_true')
-    parser.add_argument('--rebuild', action = 'store_true')
-    parser.add_argument('--flatness', action = 'store_true')
+    parser.add_argument('--rebuild',
+        action = 'store_true',
+        help = 'parses the part file and prints it back out, used for '
+            'testing whether the program interprets part files correctly',
+    )
+    parser.add_argument('--flatness',
+        action = 'store_true',
+        help = 'finds a primitive by name and prints out in which '
+            'dimensions it is flat in',
+    )
     args = parser.parse_args()
     config = load_config('ldcheck.cfg')
     for ldconfig_ldr_path in find_ldconfig_ldr_paths(config):

mercurial