From 0f739d5a814c9212464a2f2b6d2064308c016ac0 Mon Sep 17 00:00:00 2001 From: Jan Kisel Date: Thu, 3 Apr 2025 18:19:39 +0200 Subject: [PATCH] fix description of Cancel/Terminate workflow --- client/client.go | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/client/client.go b/client/client.go index e2ec88d00..3069c9ca7 100644 --- a/client/client.go +++ b/client/client.go @@ -159,7 +159,7 @@ type ( SignalWithStartWorkflow(ctx context.Context, workflowID string, signalName string, signalArg interface{}, options StartWorkflowOptions, workflowFunc interface{}, workflowArgs ...interface{}) (*workflow.Execution, error) - // CancelWorkflow cancels a workflow in execution + // CancelWorkflow cancels a workflow in execution. It allows workflow to properly clean up and gracefully close. // - workflow ID of the workflow. // - runID can be default(empty string). if empty string then it will pick the running execution of that workflow ID. // The errors it can return: @@ -169,7 +169,7 @@ type ( // - WorkflowExecutionAlreadyCompletedError CancelWorkflow(ctx context.Context, workflowID string, runID string, opts ...CancelOption) error - // TerminateWorkflow terminates a workflow execution. + // TerminateWorkflow terminates a workflow execution. Unlike Cancel, Terminate kills the workflow immediately. // workflowID is required, other parameters are optional. // - workflow ID of the workflow. // - runID can be default(empty string). if empty string then it will pick the running execution of that workflow ID.