Skip to content

fix description of Cancel/Terminate workflow #1419

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
+2 −2
Open

fix description of Cancel/Terminate workflow #1419

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0f739d5
fix description of Cancel/Terminate workflow
dkrotx Apr 3, 2025
4ca42a3
Merge branch 'master' into fix-clientapi-comment
dkrotx Apr 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions client/client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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.
Expand Down