Updated documentation on argument parsing

richard-tien · Nov 10, 2017 · 50aba7e · 50aba7e
1 parent fd760d6
commit 50aba7e
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/script_template.py b/script_template.py
@@ -13,7 +13,8 @@
 def main():
     parser = argparse.ArgumentParser( description='Put a description of your script here')
 
-    ## output file to be written
+    ## Add arguments for your script here.  Already added are -i and -o for input/output.
+    #  More information on argument parsing here: https://docs.python.org/3/howto/argparse.html
     parser.add_argument('-i', '--input_file', type=str, required=True, help='Path to an input file to be read' )
     parser.add_argument('-o', '--output_file', type=str, required=True, help='Path to an output file to be created' )
     args = parser.parse_args()