DockerCLI/cli/command/swarm
Sebastiaan van Stijn c60b360c33
cli: improve argument validation output
Improve the output for these validation errors:

- Removes the short command description from the output. This information
  does not provide much useful help, and distracts from the error message.
- Reduces punctuation, and
- Prefixes the error message with the binary / root-command name
  (usually `docker:`) to be consistent with other similar errors.
- Adds an empty line between the error-message and the "call to action"
  (`Run 'docker volume --help'...` in the example below). This helps
  separating the error message and "usage" from the call-to-action.

Before this patch:

    $ docker volume ls one two three
    "docker volume ls" accepts no arguments.
    See 'docker volume ls --help'.

    Usage:  docker volume ls [OPTIONS]

    List volumes

    $ docker volume create one two three
    "docker volume create" requires at most 1 argument.
    See 'docker volume create --help'.

    Usage:  docker volume create [OPTIONS] [VOLUME]

    Create a volume

With this patch:

    $ docker volume ls one two three
    docker: 'docker volume ls' accepts no arguments

    Usage:  docker volume ls [OPTIONS]

    Run 'docker volume ls --help' for more information

    $ docker voludocker volume create one two three
    docker: 'docker volume create' requires at most 1 argument

    Usage:  docker volume create [OPTIONS] [VOLUME]

    SRun 'docker volume create --help' for more information

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2024-07-05 03:35:14 +02:00
..
progress Switch from x/net/context to context 2018-05-11 16:49:43 -07:00
testdata Removed all mentions of "please" from docs and messages 2024-06-11 16:53:40 +02:00
ca.go Plumb contexts through commands 2023-12-12 22:30:16 +01:00
ca_test.go test spring-cleaning 2024-07-04 01:35:12 +02:00
client_test.go golangci-lint: revive: enable import-shadowing 2023-11-20 19:52:41 +01:00
cmd.go hide swarm-related commands based on the current swarm status and role 2022-05-02 14:57:59 +02:00
init.go Plumb contexts through commands 2023-12-12 22:30:16 +01:00
init_test.go test spring-cleaning 2024-07-04 01:35:12 +02:00
ipnet_slice.go format code with gofumpt 2022-09-30 11:59:11 +02:00
ipnet_slice_test.go linting: fmt.Sprintf can be replaced with string concatenation (perfsprint) 2024-06-10 21:19:32 +02:00
join.go Plumb contexts through commands 2023-12-12 22:30:16 +01:00
join_test.go cli: improve argument validation output 2024-07-05 03:35:14 +02:00
join_token.go Plumb contexts through commands 2023-12-12 22:30:16 +01:00
join_token_test.go cli: improve argument validation output 2024-07-05 03:35:14 +02:00
leave.go Plumb contexts through commands 2023-12-12 22:30:16 +01:00
leave_test.go test spring-cleaning 2024-07-04 01:35:12 +02:00
opts.go golangci-lint: revive: enable import-shadowing 2023-11-20 19:52:41 +01:00
opts_test.go linting: ST1005: error strings should not be capitalized (stylecheck) 2022-09-03 21:25:42 +02:00
unlock.go Removed all mentions of "please" from docs and messages 2024-06-11 16:53:40 +02:00
unlock_key.go Removed all mentions of "please" from docs and messages 2024-06-11 16:53:40 +02:00
unlock_key_test.go test spring-cleaning 2024-07-04 01:35:12 +02:00
unlock_test.go test spring-cleaning 2024-07-04 01:35:12 +02:00
update.go Plumb contexts through commands 2023-12-12 22:30:16 +01:00
update_test.go test spring-cleaning 2024-07-04 01:35:12 +02:00