Improve doc

Author: hanke0

tools/runbenchmark.py

@@ -1,4 +1,21 @@
 #!/usr/bin/env python
+"""
+A benchmark runner.
+
+Files and functions that match pattern 'benchmark_*' is executed as a benchmark.
+
+Use decorator `benchmark_setup` to run setup before run benchmark.
+
+A typical benchmark example:
+```
+@benchmark_setup(hack_into=int)
+def benchmark_print_int(hack_into):
+    for i in range(100):
+        print(hack_info)
+```
+
+
+"""
 import glob
 import os
 import argparse
@@ -153,15 +170,23 @@ def _pretty_rv(loop, repeat, costs):
 
 
 def main():
-    parser = argparse.ArgumentParser()
+    parser = argparse.ArgumentParser(
+        prog=os.path.basename(sys.argv[0]), description=__doc__.lstrip().splitlines()[0]
+    )
     parser.add_argument("path", default=["."], nargs="+")
-    parser.add_argument("-p", "--python-path", default=["."], nargs="*")
+    parser.add_argument(
+        "-p",
+        "--python-path",
+        default=["."],
+        nargs="*",
+        help="paths inserted to sys.path",
+    )
     parser.add_argument(
         "-e",
         "--error-exit",
         default=False,
         action="store_true",
-        help="Exit if error occurred",
+        help="exit if error occurred",
     )
 
     args = parser.parse_args()

tools/runtest.py

@@ -1,4 +1,10 @@
 #!/usr/bin/env python
+"""
+A auto unit tests runner for CTools.
+
+Use standard unittest library, so we can run in any python environment (no need install pytest).
+
+"""
 import sys
 import os
 import shutil
@@ -37,25 +43,27 @@ def _show_info():
     sys.stderr.flush()
 
 
-parser = argparse.ArgumentParser()
+parser = argparse.ArgumentParser(
+    prog=os.path.basename(sys.argv[0]), description=__doc__.lstrip().splitlines()[0]
+)
 parser.add_argument(
-    "-k", dest="pattern", help="Only run tests which match the given substring"
+    "-k", dest="pattern", help="only run tests which match the given substring"
 )
-parser.add_argument("-v", "--verbose", dest="verbose", help="Verbose output")
-parser.add_argument("-q", "--quiet", dest="quiet", help="Quiet output")
+parser.add_argument("-v", "--verbose", dest="verbose", help="verbose output")
+parser.add_argument("-q", "--quiet", dest="quiet", help="quiet output")
 parser.add_argument(
     "-s",
     "--start-directory",
     default=".",
     dest="start_directory",
-    help="Directory to start discovery ('.' default)",
+    help="directory to start discovery ('.' default)",
 )
 parser.add_argument(
     "-p",
     "--python-path",
     dest="python_path",
     action="append",
-    help="Include python path",
+    help="python path inserted into sys.path",
 )