From 5c97aa8bafe2072e7a54a39c4f50940521ebbed7 Mon Sep 17 00:00:00 2001 From: "Brian D. Klahn" Date: Thu, 24 Oct 2024 23:02:09 -0400 Subject: [PATCH] Show how to add parameter help text. --- src/app_script001.py | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/src/app_script001.py b/src/app_script001.py index e95577f..80398cf 100755 --- a/src/app_script001.py +++ b/src/app_script001.py @@ -19,8 +19,19 @@ def main( outdir: str = "./" ): """ - Put any lines of code you would normally have in a + This is the default function called when the script + is run from the command line. You can put any lines + of code you might normally have globally in a simple Python "script" here. + + Parameters + ---------- + name: str + The name of the person. + age: int + The age of the person. + outdir: str + The (created) directory the output file will be put in. """ outpath = Path(outdir) outpath.mkdir(exist_ok=True, parents=True)