Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix yamldocs outputing [flags] in usage output #1539

Merged
merged 1 commit into from
Nov 29, 2018

Conversation

thaJeztah
Copy link
Member

A similar change was made in the CLI itself in #1069, but is not inherited by the code that generates the YAML docs.

Before this patch is applied;

usage: docker container exec [OPTIONS] CONTAINER COMMAND [ARG...] [flags]

With this patch applied:

usage: docker container exec [OPTIONS] CONTAINER COMMAND [ARG...]

- How to verify it

run make -f docker.Makefile yamldocs and check the generated YAML files in docs/yaml/gen/

A similar change was made in the CLI itself, but is not
inherited by the code that generates the YAML docs.

Before this patch is applied;

```
usage: docker container exec [OPTIONS] CONTAINER COMMAND [ARG...] [flags]
```

With this patch applied:

```
usage: docker container exec [OPTIONS] CONTAINER COMMAND [ARG...]
```

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

ping @tiborvass @vdemeester PTAL

/cc @seemethere @ahh-docker

@codecov-io
Copy link

Codecov Report

Merging #1539 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #1539   +/-   ##
=======================================
  Coverage   55.22%   55.22%           
=======================================
  Files         289      289           
  Lines       19389    19389           
=======================================
  Hits        10708    10708           
  Misses       7984     7984           
  Partials      697      697

Copy link
Collaborator

@vdemeester vdemeester 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

@andrewhsu andrewhsu left a comment

Choose a reason for hiding this comment

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

LGTM

@andrewhsu andrewhsu merged commit 504cecf into docker:master Nov 29, 2018
@GordonTheTurtle GordonTheTurtle added this to the 19.03.0 milestone Nov 29, 2018
@thaJeztah thaJeztah deleted the fix_flags_in_usage branch November 29, 2018 21:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants