fix(doc): generate docs with new parameters

defelmnq · defelmnq · commit 6b138a63a2e6 · 2024-10-16T16:34:53.000Z
diff --git a/cli/testdata/coder_restart_--help.golden b/cli/testdata/coder_restart_--help.golden
@@ -19,7 +19,8 @@ OPTIONS:
           DEPRECATED: Use --prompt-ephemeral-parameters instead.
 
       --ephemeral-parameter string-array, $CODER_EPHEMERAL_PARAMETER
-          Define ephemeral parameters in the format "name=value".
+          Set the value of ephemeral parameters defined in the template. The
+          format is "name=value".
 
       --parameter string-array, $CODER_RICH_PARAMETER
           Rich parameter value in the format "name=value".
@@ -28,7 +29,9 @@ OPTIONS:
           Rich parameter default values in the format "name=value".
 
       --prompt-ephemeral-parameters bool, $CODER_PROMPT_EPHEMERAL_PARAMETERS
-          Prompt for values of ephemeral parameters described in the template.
+          Prompt to set values of ephemeral parameters defined in the template.
+          If a value has been set via --ephemeral-parameter, it will not be
+          prompted for.
 
       --rich-parameter-file string, $CODER_RICH_PARAMETER_FILE
           Specify a file path with values for rich parameters defined in the
diff --git a/cli/testdata/coder_start_--help.golden b/cli/testdata/coder_start_--help.golden
@@ -19,7 +19,8 @@ OPTIONS:
           DEPRECATED: Use --prompt-ephemeral-parameters instead.
 
       --ephemeral-parameter string-array, $CODER_EPHEMERAL_PARAMETER
-          Define ephemeral parameters in the format "name=value".
+          Set the value of ephemeral parameters defined in the template. The
+          format is "name=value".
 
       --parameter string-array, $CODER_RICH_PARAMETER
           Rich parameter value in the format "name=value".
@@ -28,7 +29,9 @@ OPTIONS:
           Rich parameter default values in the format "name=value".
 
       --prompt-ephemeral-parameters bool, $CODER_PROMPT_EPHEMERAL_PARAMETERS
-          Prompt for values of ephemeral parameters described in the template.
+          Prompt to set values of ephemeral parameters defined in the template.
+          If a value has been set via --ephemeral-parameter, it will not be
+          prompted for.
 
       --rich-parameter-file string, $CODER_RICH_PARAMETER_FILE
           Specify a file path with values for rich parameters defined in the
diff --git a/cli/testdata/coder_update_--help.golden b/cli/testdata/coder_update_--help.golden
@@ -21,7 +21,8 @@ OPTIONS:
           DEPRECATED: Use --prompt-ephemeral-parameters instead.
 
       --ephemeral-parameter string-array, $CODER_EPHEMERAL_PARAMETER
-          Define ephemeral parameters in the format "name=value".
+          Set the value of ephemeral parameters defined in the template. The
+          format is "name=value".
 
       --parameter string-array, $CODER_RICH_PARAMETER
           Rich parameter value in the format "name=value".
@@ -30,7 +31,9 @@ OPTIONS:
           Rich parameter default values in the format "name=value".
 
       --prompt-ephemeral-parameters bool, $CODER_PROMPT_EPHEMERAL_PARAMETERS
-          Prompt for values of ephemeral parameters described in the template.
+          Prompt to set values of ephemeral parameters defined in the template.
+          If a value has been set via --ephemeral-parameter, it will not be
+          prompted for.
 
       --rich-parameter-file string, $CODER_RICH_PARAMETER_FILE
           Specify a file path with values for rich parameters defined in the
