Rename option arguments to indicate expected type#1650
Merged
mosteo merged 1 commit intoMar 18, 2024
Merged
Conversation
In commands with options that admit arguments, like '--prefix' in 'alr install', is useful to provide an argument name in the command help that gives a hint of the expected type. For example, 'alr install -h' shows the message: ==== OPTIONS --prefix=ARG Override installation prefix (default is ...) ==== When changed to: ==== OPTIONS --prefix=DIR Override installation prefix (default is ...) ==== the 'DIR' name of the argument immediately says what is expected in this option. In cases where this is not so obvious, it helps even more. For example, in 'alr build -h': ==== OPTIONS --profiles=LIST Comma-separated list of <crate>=<profile> values (see description) --stop-after=STAGE Build stage after which to stop (see description) ==== is a quick remainder of what is expected in that options.
Contributor
Author
|
Don't understand why it failed in Any idea? |
mosteo
approved these changes
Mar 18, 2024
mosteo
pushed a commit
that referenced
this pull request
Mar 18, 2024
In commands with options that admit arguments, like '--prefix' in 'alr install', is useful to provide an argument name in the command help that gives a hint of the expected type. For example, 'alr install -h' shows the message: ==== OPTIONS --prefix=ARG Override installation prefix (default is ...) ==== When changed to: ==== OPTIONS --prefix=DIR Override installation prefix (default is ...) ==== the 'DIR' name of the argument immediately says what is expected in this option. In cases where this is not so obvious, it helps even more. For example, in 'alr build -h': ==== OPTIONS --profiles=LIST Comma-separated list of <crate>=<profile> values (see description) --stop-after=STAGE Build stage after which to stop (see description) ==== is a quick remainder of what is expected in that options.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 commands with options that admit arguments, like
--prefixinalr install, is useful to provide an argument name in the command help that gives a hint of the expected type.For example,
alr install -hshows the message:When changed to:
the
DIRname of the argument immediately says what is expected in this option. In cases where this is not so obvious, it helps even more.For example, in
alr build -h:is a quick remainder of what is expected in that options.