Browse Source

Fix ls --quiet help description

Signed-off-by: Max Proske <[email protected]>
Max Proske 9 months ago
parent
commit
2884d6df0d
3 changed files with 3 additions and 3 deletions
  1. 1 1
      cmd/compose/list.go
  2. 1 1
      docs/reference/compose_ls.md
  3. 1 1
      docs/reference/docker_compose_ls.yaml

+ 1 - 1
cmd/compose/list.go

@@ -50,7 +50,7 @@ func listCommand(dockerCli command.Cli, backend api.Service) *cobra.Command {
 		ValidArgsFunction: noCompletion(),
 	}
 	lsCmd.Flags().StringVar(&lsOpts.Format, "format", "table", "Format the output. Values: [table | json]")
-	lsCmd.Flags().BoolVarP(&lsOpts.Quiet, "quiet", "q", false, "Only display IDs")
+	lsCmd.Flags().BoolVarP(&lsOpts.Quiet, "quiet", "q", false, "Only display project names")
 	lsCmd.Flags().Var(&lsOpts.Filter, "filter", "Filter output based on conditions provided")
 	lsCmd.Flags().BoolVarP(&lsOpts.All, "all", "a", false, "Show all stopped Compose projects")
 

+ 1 - 1
docs/reference/compose_ls.md

@@ -11,7 +11,7 @@ Lists running Compose projects
 | `--dry-run`     | `bool`   |         | Execute command in dry run mode            |
 | `--filter`      | `filter` |         | Filter output based on conditions provided |
 | `--format`      | `string` | `table` | Format the output. Values: [table \| json] |
-| `-q`, `--quiet` | `bool`   |         | Only display IDs                           |
+| `-q`, `--quiet` | `bool`   |         | Only display project names                 |
 
 
 <!---MARKER_GEN_END-->

+ 1 - 1
docs/reference/docker_compose_ls.yaml

@@ -39,7 +39,7 @@ options:
       shorthand: q
       value_type: bool
       default_value: "false"
-      description: Only display IDs
+      description: Only display project names
       deprecated: false
       hidden: false
       experimental: false