ch01: add docstrings

JBSP-code · JBSP-code · commit c8d7c9b64b36 · 2023-01-02T13:52:16.000+01:00
diff --git a/01_hello/hello.py b/01_hello/hello.py
@@ -1,10 +1,14 @@
 #!/usr/bin/env python
-# Purpose: Say hello
+"""
+Author: Jeffrey Schmid-Paz
+Purpose: Say hello
+"""
 
 import argparse
 
 
 def get_args():
+    """Get the command-line arguments"""
     parser = argparse.ArgumentParser(description="Say hello")
     parser.add_argument(
         "-n", "--name", metavar="name", default="World", help="Name to greet"
@@ -13,6 +17,7 @@ def get_args():
 
 
 def main():
+    """Run the program"""
     args = get_args()
     print("Hello, " + args.name + "!")
 
