Add argument ranges and defaults to command line help text. #74
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
vszakats
reviewed
Feb 29, 2024
Co-authored-by: Viktor Szakats <[email protected]>
|
Thanks! If we used StructOpt this would be much easier. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In the absence of a manpage, it helps to include acceptable value ranges, and maybe even defaults, in the help output of a command. Granted, manually trying outlandish arguments does produce error messages which indicate ranges where relevant, but I see no reason for these to be mutually exclusive.
The exact format in which to include this information in the help output can be discussed; this just seemed good enough to me.
Ideally, these would be included programmatically, rather than hardcoded into the argument description strings, but I'd prefer to leave that up to the developer(s).