workflow section audit - #5297
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
| It is a powerful method for introducing compatible changes without introducing non-determinism errors. | ||
| It introduces compatible changes without causing non-determinism errors. | ||
|
|
||
| ### Detailed Overview of the Patched Function |
There was a problem hiding this comment.
📝 [vale] <Temporal.Headings> reported by reviewdog 🐶
'Detailed Overview of the Patched Function' should use sentence-style capitalization.
| It is a powerful method for introducing compatible changes without introducing non-determinism errors. | ||
| It introduces compatible changes without causing non-determinism errors. | ||
|
|
||
| ### Detailed Description of the Patched Function |
There was a problem hiding this comment.
📝 [vale] <Temporal.Headings> reported by reviewdog 🐶
'Detailed Description of the Patched Function' should use sentence-style capitalization.
📖 Docs PR preview links
|
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 9e388643cf
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
| Avoid setting Workflow Timeouts. Workflows are designed to be long-running and resilient, and a Timeout limits a Workflow's ability to handle unexpected delays or long-running processes. | ||
| To perform an action inside your Workflow after a specific period of time, use a Timer instead. |
There was a problem hiding this comment.
Apply the timeout rewrite to the concept page
The same three-sentence timeout guidance remains unchanged in docs/encyclopedia/detecting-workflow-failures.mdx:17-19, so readers of the main concept page still get the filler-heavy wording removed from the SDK pages. Apply this concise rewrite there as well to keep the shared guidance consistent.
AGENTS.md reference: AGENTS.md:L236-L240
Useful? React with 👍 / 👎.
What does this PR do?
timeouts.mdx: all eight pages now use "Workflow timeouts" and "Workflow retries" at the same heading level.
Notes to reviewers