Skip to content

Commit 5748637

Browse files
committed
comments refined
1 parent 332d275 commit 5748637

2 files changed

Lines changed: 9 additions & 10 deletions

File tree

temporal/api/history/v1/message.proto

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -771,7 +771,7 @@ message StartChildWorkflowExecutionInitiatedEventAttributes {
771771
// Priority metadata
772772
temporal.api.common.v1.Priority priority = 20;
773773

774-
// The propagated time-skipping config for the child workflow.
774+
// The propagated time-skipping configuration for the child workflow.
775775
temporal.api.workflow.v1.TimeSkippingConfig time_skipping_config = 21;
776776
}
777777

temporal/api/workflow/v1/message.proto

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -580,8 +580,8 @@ message WorkflowExecutionOptions {
580580
temporal.api.common.v1.Priority priority = 2;
581581

582582
// Time-skipping configuration for this workflow execution.
583-
// If not set, the time-skipping conf will not get updated upon request,
584-
// i.e. the existing time-skipping conf will be preserved.
583+
// If not set, the time-skipping configuration is not updated by this request;
584+
// the existing configuration is preserved.
585585
TimeSkippingConfig time_skipping_config = 3;
586586
}
587587

@@ -594,12 +594,11 @@ message WorkflowExecutionOptions {
594594
//
595595
// Propagation behavior of time skipping:
596596
// The enabled flag, bound fields, and accumulated skipped duration are propagated to related executions as follows:
597-
// (1) Child workflows and continue-as-new: both the configuration and accumulated skipped duration are inherited
598-
// from the current execution. The configured bound is shared across both the inherited skipped duration
599-
// and any additional duration skipped by the new run.
600-
// (2) Retry and cron: both the configuration and accumulated skipped duration are inherited as recorded in the
601-
// StartWorkflowExecutionEvent of the current workflow and the accummulated skipped duration
602-
// of the current run won't be passed.
597+
// (1) Child workflows and continue-as-new: both the configuration and the accumulated skipped duration are
598+
// inherited from the current execution. The configured bound is shared between the inherited skipped
599+
// duration and any additional duration skipped by the new run.
600+
// (2) Retry and cron: the configuration and accumulated skipped duration are inherited as recorded when the
601+
// current workflow started; the accumulated skipped duration of the current run is not propagated.
603602
// (3) Reset: the new run retains the time-skipping configuration of the current execution. Because reset replays
604603
// all events up to the reset point and re-applies any UpdateWorkflowExecutionOptions changes made after that
605604
// point, the resulting run ends up with the same final time-skipping configuration as the previous run.
@@ -613,7 +612,7 @@ message TimeSkippingConfig {
613612
// Optional bound that limits the gap between the virtual time of this execution and wall-clock time.
614613
// Once the bound is reached, time skipping is automatically disabled,
615614
// but can be re-enabled by setting `enabled` to true via UpdateWorkflowExecutionOptions.
616-
// This bound cannot be set to a value smaller than the current skipped duration of the current execution.
615+
// This bound cannot be set to a value smaller than the execution's currently skipped duration.
617616
//
618617
// This is useful in testing scenarios where a workflow is expected to receive
619618
// signals, updates, or other external events while timers are in progress.

0 commit comments

Comments
 (0)