docs(cli): clarify stop v. terminate with Long descriptions (#1…

…1626) Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
argoproj · Sep 5, 2023 · 81ccebd · 81ccebd
1 parent f3000b9
commit 81ccebd
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 0 deletions.
diff --git a/cmd/argo/commands/stop.go b/cmd/argo/commands/stop.go
@@ -38,6 +38,7 @@ func NewStopCommand() *cobra.Command {
 	command := &cobra.Command{
 		Use:   "stop WORKFLOW WORKFLOW2...",
 		Short: "stop zero or more workflows allowing all exit handlers to run",
+		Long:  "Stop a workflow but still run exit handlers.",
 		Example: `# Stop a workflow:
 
   argo stop my-wf

diff --git a/cmd/argo/commands/terminate.go b/cmd/argo/commands/terminate.go
@@ -46,6 +46,7 @@ func NewTerminateCommand() *cobra.Command {
 	command := &cobra.Command{
 		Use:   "terminate WORKFLOW WORKFLOW2...",
 		Short: "terminate zero or more workflows immediately",
+		Long:  "Immediately stop a workflow and do not run any exit handlers.",
 		Example: `# Terminate a workflow:
 
   argo terminate my-wf

diff --git a/docs/cli/argo_stop.md b/docs/cli/argo_stop.md
@@ -2,6 +2,10 @@
 
 stop zero or more workflows allowing all exit handlers to run
 
+### Synopsis
+
+Stop a workflow but still run exit handlers.
+
 ```
 argo stop WORKFLOW WORKFLOW2... [flags]
 ```

diff --git a/docs/cli/argo_terminate.md b/docs/cli/argo_terminate.md
@@ -2,6 +2,10 @@
 
 terminate zero or more workflows immediately
 
+### Synopsis
+
+Immediately stop a workflow and do not run any exit handlers.
+
 ```
 argo terminate WORKFLOW WORKFLOW2... [flags]
 ```