update error message for invalid subcommand usage #1029
Merged
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
bamarni
force-pushed
the
dcos-community-95
branch
2 times, most recently
from
31602f1
to
aab6a2d
Compare
3e66e12 added an explicit error message for subcommand invalid usage. This change rephrases it to make it clear that the subcommand exists but is being misused. https://jira.mesosphere.com/browse/DCOS_COMMUNITY-95
bamarni
force-pushed
the
dcos-community-95
branch
from
aab6a2d
to
4b3a4fb
Compare
klueska
reviewed
Aug 15, 2017
| @@ -23,7 +23,7 @@ def wrapper(*args, **kwargs): | |||
| try: | |||
| result = func(*args, **kwargs) | |||
| except docopt.DocoptExit as e: | |||
| emitter.publish("Command not recognized\n") | |||
| emitter.publish("Invalid subcommand usage\n") | |||
There was a problem hiding this comment.
Is this the standard response? What do other subcommands say here?
There was a problem hiding this comment.
This would be this same message for all subcommands if they are misused (auth, job, etc.), this is only different for subcommands which have their own binary, where the behaviour depends on the executable I think.
Some examples :
(dcos-cli/cli) ➜ cli git:(dcos-community-95) dcos auth
Invalid subcommand usage
Usage:
dcos auth --help
dcos auth --info
dcos auth --version
dcos auth list-providers [--json]
dcos auth login
[--provider=<provider_id>] [--username=<username>]
[--password=<password> | --password-file=<password_file>
| --password-env=<password_env> | --private-key=<key_path>]
dcos auth logout
(dcos-cli/cli) ➜ cli git:(dcos-community-95) dcos job --invalid
Invalid subcommand usage
Usage:
dcos job --config-schema
dcos job --help
dcos job --info
dcos job --version
dcos job add <job-file>
dcos job remove <job-id> [--stop-current-job-runs]
dcos job show <job-id>
dcos job update <job-file>
dcos job kill <job-id> [<run-id>][--all]
dcos job run <job-id> [--json]
dcos job list [--json]
dcos job schedule add <job-id> <schedule-file>
dcos job schedule show <job-id> [--json]
dcos job schedule remove <job-id> <schedule-id>
dcos job schedule update <job-id> <schedule-file>
dcos job show runs <job-id> [--run-id <run-id>][--json][--q]
dcos job history <job-id> [--json][--show-failures]
There was a problem hiding this comment.
Cool. It would be good to have a common string abstracted out for this, but we can leave this as future work.
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.
3e66e12 added an explicit error message for invalid subcommand usage.
This change rephrases it to make it clear that the subcommand exists but is being misused.
https://jira.mesosphere.com/browse/DCOS_COMMUNITY-95