add more help text to mkdb.py

1 files changed, 24 insertions, 5 deletions

diff --git a/scripts/mkdb.py b/scripts/mkdb.py
index d3786f1..5e555b5 100755
--- a/scripts/mkdb.py
+++ b/scripts/mkdb.py
@@ -27,11 +27,30 @@ def truncate(path: Path) -> None:
 def main() -> int:
     parser = ArgumentParser()
 
-    parser.add_argument("--database", type=Path, required=True)
-    parser.add_argument("--word-list", type=Path, required=True)
-    parser.add_argument("--num-records", type=int, required=True)
-    parser.add_argument("--key-length", type=Range, required=True)
-    parser.add_argument("--value-length", type=Range, required=True)
+    parser.add_argument(
+        "--database",
+        type=Path,
+        required=True,
+        help="path to a file to store the database",
+    )
+    parser.add_argument(
+        "--word-list",
+        type=Path,
+        required=True,
+        help="a file containing newline separated list of words",
+    )
+    parser.add_argument(
+        "--num-records",
+        type=int,
+        required=True,
+        help="the number or records to store in the database",
+    )
+    parser.add_argument(
+        "--key-length", type=Range, required=True, help="a range such as 1-10"
+    )
+    parser.add_argument(
+        "--value-length", type=Range, required=True, help="a range such as 1-10"
+    )
 
     args = parser.parse_args()