Skip to content

Commit 91c82a2

Browse files
Fix godocs for child policy (#662)
1 parent 759f50a commit 91c82a2

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

internal/workflow.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ type (
165165
TaskStartToCloseTimeout time.Duration
166166

167167
// ChildPolicy defines the behavior of child workflow when parent workflow is terminated.
168-
// Optional: default to use ChildWorkflowPolicyTerminate if this is not provided
168+
// Optional: default to use ChildWorkflowPolicyAbandon. We currently only support this policy.
169169
ChildPolicy ChildWorkflowPolicy
170170

171171
// WaitForCancellation - Whether to wait for cancelled child workflow to be ended (child workflow can be ended
@@ -205,9 +205,11 @@ type (
205205

206206
const (
207207
// ChildWorkflowPolicyTerminate is policy that will terminate all child workflows when parent workflow is terminated.
208+
// TODO: this is not supported yet
208209
ChildWorkflowPolicyTerminate ChildWorkflowPolicy = 0
209210
// ChildWorkflowPolicyRequestCancel is policy that will send cancel request to all open child workflows when parent
210211
// workflow is terminated.
212+
// TODO: this is not supported yet
211213
ChildWorkflowPolicyRequestCancel ChildWorkflowPolicy = 1
212214
// ChildWorkflowPolicyAbandon is policy that will have no impact to child workflow execution when parent workflow is
213215
// terminated.

0 commit comments

Comments
 (0)