allocator: Amend --all flag description (#378)

Fixes the wording on the `platform allocator list --all` flag to be more accurate with what's happening behind the scenes. Signed-off-by: Marc Lopez <marc5.12@outlook.com>
elastic · Sep 14, 2020 · 41d6058 · 41d6058
1 parent 7e0a59b
commit 41d6058
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/cmd/platform/allocator/list.go b/cmd/platform/allocator/list.go
@@ -105,5 +105,5 @@ func init() {
 	listAllocatorsCmd.Flags().String("query", "", queryFlagHelp)
 	listAllocatorsCmd.Flags().Int("size", 100, "Defines the maximum number of allocators to return")
 	listAllocatorsCmd.Flags().Bool("metadata", false, "Shows allocators metadata")
-	listAllocatorsCmd.Flags().Bool("all", false, "Shows all allocators (including those with no instances or not connected)")
+	listAllocatorsCmd.Flags().Bool("all", false, "Shows all allocators, including those with no instances or not connected, this is relative to the --size flag.")
 }
diff --git a/docs/ecctl_platform_allocator_list.adoc b/docs/ecctl_platform_allocator_list.adoc
@@ -38,7 +38,7 @@ ecctl platform allocator list [flags]
 === Options
 
 ----
-      --all                  Shows all allocators (including those with no instances or not connected)
+      --all                  Shows all allocators, including those with no instances or not connected, this is relative to the --size flag.
   -f, --filter stringArray   Post-query filter out allocators based on metadata tags, for instance 'instanceType:i3.large'
   -h, --help                 help for list
       --metadata             Shows allocators metadata

diff --git a/docs/ecctl_platform_allocator_list.md b/docs/ecctl_platform_allocator_list.md
@@ -33,7 +33,7 @@ ecctl platform allocator list [flags]
 ### Options
 
 ```
-      --all                  Shows all allocators (including those with no instances or not connected)
+      --all                  Shows all allocators, including those with no instances or not connected, this is relative to the --size flag.
   -f, --filter stringArray   Post-query filter out allocators based on metadata tags, for instance 'instanceType:i3.large'
   -h, --help                 help for list
       --metadata             Shows allocators metadata