docs: some cleanup and improvements

Signed-off-by: Arthur Zamarin <arthurzam@gentoo.org>
pkgcore · Dec 30, 2023 · ad6cdeb · ad6cdeb
1 parent 8e06b8f
commit ad6cdeb
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 2 deletions.
diff --git a/doc/index.rst b/doc/index.rst
@@ -8,6 +8,7 @@ Contents:
     :maxdepth: 4
 
     man/pkgdev
+    man/pkgdev/bugs
     man/pkgdev/commit
     man/pkgdev/manifest
     man/pkgdev/mask

diff --git a/src/pkgdev/scripts/argparsers.py b/src/pkgdev/scripts/argparsers.py
@@ -50,7 +50,7 @@ class BugzillaApiKey:
     def mangle_argparser(cls, parser):
         parser.add_argument(
             "--api-key",
-            metavar="KEY",
+            metavar="TOKEN",
             help="Bugzilla API key",
             docs="""
                 The Bugzilla API key to use for authentication. WARNING: using this
@@ -61,7 +61,7 @@ def mangle_argparser(cls, parser):
                         [default]
                         key = <your API key>
 
-                ANother supported option is to save your API key in a file named
+                Another supported option is to save your API key in a file named
                 ``~/.bugz_token``.
             """,
         )

diff --git a/src/pkgdev/scripts/pkgdev_bugs.py b/src/pkgdev/scripts/pkgdev_bugs.py
@@ -58,6 +58,7 @@
     "--auto-cc-arches",
     action=arghparse.CommaSeparatedNegationsAppend,
     default=([], []),
+    metavar="EMAIL",
     help="automatically add CC-ARCHES for the listed email addresses",
     docs="""
         Comma separated list of email addresses, for which automatically add
@@ -69,6 +70,7 @@
     "--find-by-maintainer",
     action=arghparse.CommaSeparatedNegationsAppend,
     default=([], []),
+    metavar="EMAIL",
     help="collect all packages maintained by the listed email addresses",
     docs="""
         Comma separated list of email addresses, for which pkgdev will collect