Skip to content

Commit

Permalink
Show how to add parameter help text.
Browse files Browse the repository at this point in the history
  • Loading branch information
bdklahn committed Oct 25, 2024
1 parent bcdf3b9 commit 5c97aa8
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion src/app_script001.py
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down

0 comments on commit 5c97aa8

Please sign in to comment.