diff --git a/packages/common/src/activity-options.ts b/packages/common/src/activity-options.ts index 3c02f05ae..b9c2cff77 100644 --- a/packages/common/src/activity-options.ts +++ b/packages/common/src/activity-options.ts @@ -48,8 +48,8 @@ export interface ActivityOptions { /** * Maximum time of a single Activity execution attempt. Note that the Temporal Server doesn't detect Worker process - * failures directly. It relies on this timeout to detect that an Activity that didn't complete on time. So this - * timeout should be as short as the longest possible execution of the Activity body. Potentially long running + * failures directly: instead, it relies on this timeout to detect that an Activity didn't complete on time. Therefore, this + * timeout should be as short as the longest possible execution of the Activity body. Potentially long-running * Activities must specify {@link heartbeatTimeout} and call {@link activity.Context.heartbeat} periodically for * timely failure detection. * @@ -61,7 +61,7 @@ export interface ActivityOptions { startToCloseTimeout?: Duration; /** - * Time that the Activity Task can stay in the Task Queue before it is picked up by a Worker. Do not specify this timeout unless using host specific Task Queues for Activity Tasks are being used for routing. + * Time that the Activity Task can stay in the Task Queue before it is picked up by a Worker. Do not specify this timeout unless using host-specific Task Queues for Activity Tasks are being used for routing. * `scheduleToStartTimeout` is always non-retryable. Retrying after this timeout doesn't make sense as it would just put the Activity Task back into the same Task Queue. * * @default `scheduleToCloseTimeout` or unlimited @@ -70,7 +70,7 @@ export interface ActivityOptions { scheduleToStartTimeout?: Duration; /** - * Total time that a workflow is willing to wait for Activity to complete. + * Total time that a workflow is willing to wait for the Activity to complete. * `scheduleToCloseTimeout` limits the total time of an Activity's execution including retries (use {@link startToCloseTimeout} to limit the time of a single attempt). * * Either this option or {@link startToCloseTimeout} is required.