aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHugo Hörnquist <hugo@lysator.liu.se>2023-06-16 12:54:42 +0200
committerHugo Hörnquist <hugo@lysator.liu.se>2023-06-16 12:54:42 +0200
commit05bfe89b3736c1e940e3c6086259de51bbd22c2b (patch)
tree221a52481a33b08395cabbec0c2f689466f71085
parentAllow specifying modules directly on the command line. (diff)
downloadmuppet-strings-05bfe89b3736c1e940e3c6086259de51bbd22c2b.tar.gz
muppet-strings-05bfe89b3736c1e940e3c6086259de51bbd22c2b.tar.xz
Document command line arguments.
-rw-r--r--muppet/__main__.py9
1 files changed, 7 insertions, 2 deletions
diff --git a/muppet/__main__.py b/muppet/__main__.py
index e642010..6ca6073 100644
--- a/muppet/__main__.py
+++ b/muppet/__main__.py
@@ -13,8 +13,13 @@ def __main() -> None:
prog='puppet-doc configure',
description='Sets up puppet doc')
- parser.add_argument('--env', action='store')
- parser.add_argument('modules', nargs='*', type=pathlib.Path)
+ parser.add_argument('--env', action='store', help='''
+ Path to a puppet `modules` directory.
+ ''')
+ parser.add_argument('modules', nargs='*', type=pathlib.Path, help='''
+ Any number of specific modules to generate documentation for.
+ Mutually exclusive with --env.
+ ''')
args = parser.parse_args()