[gentoo-commits] proj/pkgcore/pkgdev:main commit in: doc/, src/pkgdev/scripts/

[gentoo-commits] proj/pkgcore/pkgdev:main commit in: doc/, src/pkgdev/scripts/

[Arthur Zamarin]

commit:     ad6cdebbc8c094dc6736d34bb7a79c7ed0227f10
Author:     Arthur Zamarin <arthurzam <AT> gentoo <DOT> org>
AuthorDate: Sat Dec 30 12:51:43 2023 +0000
Commit:     Arthur Zamarin <arthurzam <AT> gentoo <DOT> org>
CommitDate: Sat Dec 30 12:51:43 2023 +0000
URL:        https://gitweb.gentoo.org/proj/pkgcore/pkgdev.git/commit/?id=ad6cdebb

docs: some cleanup and improvements

Signed-off-by: Arthur Zamarin <arthurzam <AT> gentoo.org>

 doc/index.rst                     | 1 +
 src/pkgdev/scripts/argparsers.py  | 4 ++--
 src/pkgdev/scripts/pkgdev_bugs.py | 2 ++
 3 files changed, 5 insertions(+), 2 deletions(-)

diff --git a/doc/index.rst b/doc/index.rst
index 8570603..8fa4ae2 100644
--- 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
index 76479ff..5cefeca 100644
--- 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 @@ class BugzillaApiKey:
                         [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
index fb60ff1..1a5cd0d 100644
--- a/src/pkgdev/scripts/pkgdev_bugs.py
+++ b/src/pkgdev/scripts/pkgdev_bugs.py
@@ -58,6 +58,7 @@ bugs.add_argument(
     "--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 @@ bugs.add_argument(
     "--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