Skip to content

Commit

Permalink
yamldocs: add description to base command
Browse files Browse the repository at this point in the history
Currently the documentation uses a special case for this command,
so adding a description to the YAML in order to remove that
special case.

Signed-off-by: Sebastiaan van Stijn <[email protected]>
Upstream-commit: c4798a9daad840fba46adf0c5d03606b9a7275a9
Component: cli
  • Loading branch information
thaJeztah committed Apr 19, 2020
1 parent 57be5b5 commit 0809f70
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion components/cli/docs/yaml/generate.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,10 @@ func generateCliYaml(opts *options) error {
if err != nil {
return err
}
cmd := &cobra.Command{Use: "docker"}
cmd := &cobra.Command{
Use: "docker [OPTIONS] COMMAND [ARG...]",
Short: "The base command for the Docker CLI.",
}
commands.AddCommands(cmd, dockerCli)
disableFlagsInUseLine(cmd)
source := filepath.Join(opts.source, descriptionSourcePath)
Expand Down

0 comments on commit 0809f70

Please sign in to comment.