fix(parser) No usage for unneeded attached value #4268
Closed
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
When a value is attached to an option that does not need a value (as in
"--flag=value"), the error message included a usage line. However, that
usage line, which could be generic generated usage, "smart" usage based off
the user-provided command line, or the user-overridden usage. None of these
forms of usage provide helpful information for this class of error. The
crux of the problem is explained clearly in the error message's first line.
For example, this:
error: The value 'value' was provided to '--flag' but it wasn't expecting any more values
example --other <path>...
For more information try '--help'
Becomes this:
error: The value 'value' was provided to '--flag' but it wasn't expecting any more values
For more information try '--help'
N.B. a motivating factor is that the "no-title" usage in this error
message, in addition to being not super useful, was necessarily formatted
incorrectly with a user-overridden, multi-line usage string. For example:
error: The value 'value' was provided to '--flag' but it wasn't expecting any more values
example -X <path>...
example -Y [OPTIONS]
example -Z [OPTIONS] [path]
For more information try '--help'
Removing usage from this error message side-steps the usage formatting
issue.
|
I think I prefer we fix up the usage, rather than remove it. I've posted #4269 |
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.
When a value is attached to an option that does not need a value (as in "--flag=value"), the error message included a usage line. However, that usage line, which could be generic generated usage, "smart" usage based off the user-provided command line, or the user-overridden usage. None of these forms of usage provide helpful information for this class of error. The crux of the problem is explained clearly in the error message's first line.
For example, this:
Becomes this:
N.B. a motivating factor is that the "no-title" usage in this error message, in addition to being not super useful, was necessarily formatted incorrectly with a user-overridden, multi-line usage string. For example:
Removing usage from this error message side-steps the usage formatting issue.