Skip to content

Commit 0f739d5

Browse files
authored
fix description of Cancel/Terminate workflow
1 parent e5063a1 commit 0f739d5

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

client/client.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ type (
159159
SignalWithStartWorkflow(ctx context.Context, workflowID string, signalName string, signalArg interface{},
160160
options StartWorkflowOptions, workflowFunc interface{}, workflowArgs ...interface{}) (*workflow.Execution, error)
161161

162-
// CancelWorkflow cancels a workflow in execution
162+
// CancelWorkflow cancels a workflow in execution. It allows workflow to properly clean up and gracefully close.
163163
// - workflow ID of the workflow.
164164
// - runID can be default(empty string). if empty string then it will pick the running execution of that workflow ID.
165165
// The errors it can return:
@@ -169,7 +169,7 @@ type (
169169
// - WorkflowExecutionAlreadyCompletedError
170170
CancelWorkflow(ctx context.Context, workflowID string, runID string, opts ...CancelOption) error
171171

172-
// TerminateWorkflow terminates a workflow execution.
172+
// TerminateWorkflow terminates a workflow execution. Unlike Cancel, Terminate kills the workflow immediately.
173173
// workflowID is required, other parameters are optional.
174174
// - workflow ID of the workflow.
175175
// - runID can be default(empty string). if empty string then it will pick the running execution of that workflow ID.

0 commit comments

Comments
 (0)