Update flag documentation

elastic · May 15, 2024 · ebe1c94 · ebe1c94
1 parent a8fce88
commit ebe1c94
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/cmd/deployment/show.go b/cmd/deployment/show.go
@@ -123,5 +123,5 @@ func initShowFlags() {
 	showCmd.Flags().BoolP("metadata", "m", false, "Shows the deployment metadata")
 	showCmd.Flags().BoolP("settings", "s", false, "Shows the deployment settings")
 	showCmd.Flags().Bool("generate-update-payload", false, "Outputs JSON which can be used as an argument for the --file flag with the update command.")
-	showCmd.Flags().Bool("clear-transient", false, "Removes the `transient` field in order to make read - edit - write loop safe")
+	showCmd.Flags().Bool("clear-transient", false, "Removes the `transient` field in order to make read - edit - write loop safer. The default value of clear-transient depends on the value of `generate-update-payload`. If `generate-update-payload` is true `clear-transient` defaults to true. Otherwise defaults to false.")
 }
diff --git a/docs/ecctl_deployment_show.adoc b/docs/ecctl_deployment_show.adoc
@@ -26,7 +26,7 @@ ecctl deployment show <deployment-id> [flags]
 === Options
 
 ----
-      --clear-transient transient   Removes the transient field in order to make read - edit - write loop safe
+      --clear-transient transient   Removes the transient field in order to make read - edit - write loop safer. The default value of clear-transient depends on the value of `generate-update-payload`. If `generate-update-payload` is true `clear-transient` defaults to true. Otherwise defaults to false.
       --generate-update-payload     Outputs JSON which can be used as an argument for the --file flag with the update command.
   -h, --help                        help for show
       --kind string                 Optional deployment resource kind (apm, appsearch, kibana, elasticsearch)

diff --git a/docs/ecctl_deployment_show.md b/docs/ecctl_deployment_show.md
@@ -23,7 +23,7 @@ ecctl deployment show <deployment-id> [flags]
 ### Options
 
 ```
-      --clear-transient transient   Removes the transient field in order to make read - edit - write loop safe
+      --clear-transient transient   Removes the transient field in order to make read - edit - write loop safer. The default value of clear-transient depends on the value of `generate-update-payload`. If `generate-update-payload` is true `clear-transient` defaults to true. Otherwise defaults to false.
       --generate-update-payload     Outputs JSON which can be used as an argument for the --file flag with the update command.
   -h, --help                        help for show
       --kind string                 Optional deployment resource kind (apm, appsearch, kibana, elasticsearch)