Skip to content

Commit 2cc02fe

Browse files
seveinyycptt
authored andcommitted
Fix doc typos (#834)
1 parent 4d94977 commit 2cc02fe

File tree

6 files changed

+10
-10
lines changed

6 files changed

+10
-10
lines changed

internal/activity.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,16 +68,16 @@ type (
6868
// optional: The default task list with the same name as the workflow task list.
6969
TaskList string
7070

71-
// ScheduleToCloseTimeout - The end to end time out for the activity needed.
71+
// ScheduleToCloseTimeout - The end to end timeout for the activity needed.
7272
// The zero value of this uses default value.
7373
// Optional: The default value is the sum of ScheduleToStartTimeout and StartToCloseTimeout
7474
ScheduleToCloseTimeout time.Duration
7575

76-
// ScheduleToStartTimeout - The queue time out before the activity starts executed.
76+
// ScheduleToStartTimeout - The queue timeout before the activity starts executed.
7777
// Mandatory: No default.
7878
ScheduleToStartTimeout time.Duration
7979

80-
// StartToCloseTimeout - The time out from the start of execution to end of it.
80+
// StartToCloseTimeout - The timeout from the start of execution to end of it.
8181
// Mandatory: No default.
8282
StartToCloseTimeout time.Duration
8383

internal/client.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -321,12 +321,12 @@ type (
321321
// Mandatory: No default.
322322
TaskList string
323323

324-
// ExecutionStartToCloseTimeout - The time out for duration of workflow execution.
324+
// ExecutionStartToCloseTimeout - The timeout for duration of workflow execution.
325325
// The resolution is seconds.
326326
// Mandatory: No default.
327327
ExecutionStartToCloseTimeout time.Duration
328328

329-
// DecisionTaskStartToCloseTimeout - The time out for processing decision task from the time the worker
329+
// DecisionTaskStartToCloseTimeout - The timeout for processing decision task from the time the worker
330330
// pulled this task. If a decision task is lost, it is retried after this timeout.
331331
// The resolution is seconds.
332332
// Optional: defaulted to 10 secs.

internal/error.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@ func NewCanceledError(details ...interface{}) *CanceledError {
199199
// If the workflow main function returns this error then the current execution is ended and
200200
// the new execution with same workflow ID is started automatically with options
201201
// provided to this function.
202-
// ctx - use context to override any options for the new workflow like execution time out, decision task time out, task list.
202+
// ctx - use context to override any options for the new workflow like execution timeout, decision task timeout, task list.
203203
// if not mentioned it would use the defaults that the current workflow is using.
204204
// ctx := WithExecutionStartToCloseTimeout(ctx, 30 * time.Minute)
205205
// ctx := WithWorkflowTaskStartToCloseTimeout(ctx, time.Minute)

internal/internal_task_pollers.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -241,7 +241,7 @@ func (wtp *workflowTaskPoller) ProcessTask(task interface{}) error {
241241

242242
func (wtp *workflowTaskPoller) processWorkflowTask(task *workflowTask) error {
243243
if task.task == nil {
244-
// We didn't have task, poll might have time out.
244+
// We didn't have task, poll might have timeout.
245245
traceLog(func() {
246246
wtp.logger.Debug("Workflow task unavailable")
247247
})
@@ -817,7 +817,7 @@ func (atp *activityTaskPoller) ProcessTask(task interface{}) error {
817817

818818
activityTask := task.(*activityTask)
819819
if activityTask.task == nil {
820-
// We didn't have task, poll might have time out.
820+
// We didn't have task, poll might have timeout.
821821
traceLog(func() {
822822
atp.logger.Debug("Activity task unavailable")
823823
})

workflow/doc.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -224,7 +224,7 @@ for an activity it invoked.
224224
WorkflowID: "BID-SIMPLE-CHILD-WORKFLOW",
225225
ExecutionStartToCloseTimeout: time.Minute * 30,
226226
}
227-
ctx = workflow.WithChildWorkflowOptions(ctx, cwo)
227+
ctx = workflow.WithChildOptions(ctx, cwo)
228228
229229
var result string
230230
future := workflow.ExecuteChildWorkflow(ctx, SimpleChildWorkflow, value)

workflow/error.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ type (
109109
// If the workflow main function returns this error then the current execution is ended and
110110
// the new execution with same workflow ID is started automatically with options
111111
// provided to this function.
112-
// ctx - use context to override any options for the new workflow like execution time out, decision task time out, task list.
112+
// ctx - use context to override any options for the new workflow like execution timeout, decision task timeout, task list.
113113
// if not mentioned it would use the defaults that the current workflow is using.
114114
// ctx := WithExecutionStartToCloseTimeout(ctx, 30 * time.Minute)
115115
// ctx := WithWorkflowTaskStartToCloseTimeout(ctx, time.Minute)

0 commit comments

Comments
 (0)