Skip to content

update usage strings for consistency#9706

Merged
glours merged 1 commit intodocker:v2from
thaJeztah:improve_usage_consistency
Aug 2, 2022
Merged

update usage strings for consistency#9706
glours merged 1 commit intodocker:v2from
thaJeztah:improve_usage_consistency

Conversation

@thaJeztah
Copy link
Member

This updates the format of various usage strings to be more consistent
with other parts of the CLI.

  • Use [OPTIONS] to indicate where command-specific options should be added
  • Use [SERVICE...] to indicate zero-or-more services
  • Remove some usage strings for specific options (e.g. -e NAME=VAL), as that
    option is part of the already mentioned [OPTIONS] and we don't provide usage
    for each possible option that can be passed.
  • Remove [--], which (I think) was needed for the Python implementation, but is
    a general feature to stop processing flag-options.

What I did

Related issue

(not mandatory) A picture of a cute animal, if possible in relation with what you did

This updates the format of various usage strings to be more consistent
with other parts of the CLI.

- Use `[OPTIONS]` to indicate where command-specific options should be added
- Use `[SERVICE...]` to indicate zero-or-more services
- Remove some usage strings for specific options (e.g. `-e NAME=VAL`), as that
  option is part of the already mentioned `[OPTIONS]` and we don't provide usage
  for each possible option that can be passed.
- Remove `[--]`, which (I think) was needed for the Python implementation, but is
  a general feature to stop processing flag-options.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Copy link
Contributor

@ulyssessouza ulyssessouza left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Contributor

@glours glours left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks @thaJeztah

@glours glours merged commit 9e48afb into docker:v2 Aug 2, 2022
@thaJeztah thaJeztah deleted the improve_usage_consistency branch August 2, 2022 17:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants