temporalio / temporalio/documentation

Clarify Activity timeout defaults/normalization & explain the UpdateOptions merge-clear-normalize behavior

Open
#5,267 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
173
Forks
330
Avg merge
1d 20h
Merged PRs (30d)
156

Description

Temporal Affiliation
  • I am a Temporal employee
Page URL

https://docs.temporal.io/activity-operations

Content Issue

When schedule_to_close_timeout is set and either schedule_to_start_timeout or start_to_close_timeout is unset, the unset fields default to schedule_to_close_timeout .
The same normalization happens during start activity, and applies to both SAA and WFA.
docs.temporal.io covers the timeout defaults partially, but it doesn’t clearly explain the UpdateOptions merge-clear-normalize behavior. This can be improved in the docs there and also at CLI/SDK where applicable. Determine pages that need to be changed.

Image

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Activity Operations page at docs.temporal.io/activity-operations and review the timeout defaults and UpdateOptions behavior described there. Check the corresponding SAA and WFA sections, then identify any CLI or SDK pages that need the same explanation; done means the merge, clear, and normalize behavior and timeout defaults are documented consistently.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
65/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.