From ee4c5b30ef9878c10256f0330b5767b72f015161 Mon Sep 17 00:00:00 2001 From: Anton Gilgur <4970083+agilgur5@users.noreply.github.com> Date: Fri, 25 Aug 2023 14:35:44 -0400 Subject: [PATCH] docs(cli): clarify `stop` v. `terminate` with `Long` descriptions (#11626) Signed-off-by: Anton Gilgur Signed-off-by: Dillen Padhiar --- cmd/argo/commands/stop.go | 1 + cmd/argo/commands/terminate.go | 1 + docs/cli/argo_stop.md | 4 ++++ docs/cli/argo_terminate.md | 4 ++++ 4 files changed, 10 insertions(+) diff --git a/cmd/argo/commands/stop.go b/cmd/argo/commands/stop.go index b289b264001d..43a89b0782f3 100644 --- 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 index c20b75d374be..c10e669bbae2 100644 --- 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 index c39c73b9d33a..8475e44af78a 100644 --- 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 index 463c84c38b02..9f3530709571 100644 --- 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] ```