From: "jgart" via Bug reports for GNU Guix <bug-guix@gnu.org>
To: 63036@debbugs.gnu.org
Subject: bug#63036: -v or --verbose CLI argument input is undocumented in the CLI
Date: Sun, 23 Apr 2023 15:27:36 +0000 [thread overview]
Message-ID: <00781330fbd65f97724d7c93d9b87f09@dismail.de> (raw)
User story:
jgart tries to build a currently broken Python music package:
$ guix build -v 6 music21
Hmmm, what is the allowed input range for -v/--verbosity command line flag?
$ guix build --help
-v, --verbosity=LEVEL use the given verbosity LEVEL
Hmmm, what is the type and/or range of inputs that are valid for LEVEL?
Darn, I have to go find what the underlying implementation function takes as a valid verbosity level in the source code instead of just reading the documentation output of `guix build --help`.
...but I just want to know everything that I need to know from just using the CLI and its help system as the user.
jgart adds TODO to document the valid levels in the CLI verbosity option itself
jgart thinks but what if the help message on the valid levels is too long once added?
jgart goes to get ice cream
next reply other threads:[~2023-04-23 16:54 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-04-23 15:27 jgart via Bug reports for GNU Guix [this message]
2023-04-25 12:36 ` bug#63036: -v or --verbose CLI argument input is undocumented in the CLI Simon Tournier
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://guix.gnu.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=00781330fbd65f97724d7c93d9b87f09@dismail.de \
--to=bug-guix@gnu.org \
--cc=63036@debbugs.gnu.org \
--cc=jgart@dismail.de \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/guix.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).