From 05bfe89b3736c1e940e3c6086259de51bbd22c2b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Hugo=20H=C3=B6rnquist?= <hugo@lysator.liu.se>
Date: Fri, 16 Jun 2023 12:54:42 +0200
Subject: [PATCH] Document command line arguments.
---
muppet/__main__.py | 9 +++++++--
1 file 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()
--
GitLab