Back to all reviewers

workflow documentation clarity

cloudflare/workers-sdk
Based on 2 comments
TypeScript

Ensure all workflow-related documentation, help text, and code comments use proper grammar and punctuation. Workflow systems involve complex orchestration, retries, and fault tolerance mechanisms that require clear, professional documentation for maintainability and developer understanding.

Temporal TypeScript

Reviewer Prompt

Ensure all workflow-related documentation, help text, and code comments use proper grammar and punctuation. Workflow systems involve complex orchestration, retries, and fault tolerance mechanisms that require clear, professional documentation for maintainability and developer understanding.

Pay special attention to:

  • Proper comma usage in lists and clauses
  • Clear sentence structure in workflow descriptions
  • Professional formatting of code comments explaining workflow behavior

Example of proper formatting:

// You can optionally have a Workflow wait for additional data,
// human approval or an external webhook or HTTP request, before progressing.

// Help text should read:
// "For multi-step applications that automatically retry, persist state, and run for minutes, hours, days or weeks"

Well-documented workflows reduce onboarding time and prevent misunderstandings about complex temporal execution patterns.

2
Comments Analyzed
TypeScript
Primary Language
Temporal
Category

Source Discussions