Skip to content

language.md

Latest commit

 

History

History
63 lines (51 loc) · 3.6 KB

language.md

File metadata and controls

63 lines (51 loc) · 3.6 KB

{language}.md (top-level files)

Tracks alignment for python.md, typescript.md, go.md, etc.

Section Inventory

Section Core Python Py# TypeScript TS# Ruby Rb# Go Go#
Overview — ✓ 1 ✓ 1 TODO 1 ✓ 1
How Temporal Works: History Replay — — — — — — — — —
Understanding Replay — — — ✓ 2 — — — —
Quick Start / Quick Demo — ✓ 2 ✓ 3 TODO 2 ✓ 2
Key Concepts — ✓ 3 ✓ 4 TODO 3 ✓ 3
File Organization Best Practice — ✓ 4 ✓ 5 TODO 4 ✓ 4
Determinism Rules — — — ✓ 6 — — — —
Common Pitfalls — ✓ 5 ✓ 7 TODO 5 ✓ 5
Writing Tests — ✓ 6 ✓ 8 TODO 6 ✓ 6
Additional Resources — ✓ 7 ✓ 9 TODO 7 ✓ 7

Style Compliance

Language Status Notes
Python ✓ reference —
TypeScript ✓ aligned Has Understanding Replay, Determinism Rules
Ruby — Not started
Go ✓ aligned Function-based (no decorators), workflowcheck, struct activities

Status

Ruby notes:

  • Overview: gem installation (gem 'temporalio'), Ruby 3.3+, macOS/Linux only
  • Quick Start: Full tutorial with activity class, workflow class, worker, client (4 files like Python/TS)
  • Key Concepts: Workflows as classes (< Temporalio::Workflow::Definition), Activities as classes (< Temporalio::Activity::Definition), Temporalio::Workflow.execute_activity, determinism via Illegal Call Tracing
  • File Organization: Ruby class-based approach (one class per file convention)
  • Common Pitfalls: Using sleep instead of Temporalio::Workflow.sleep, using Time.now instead of Temporalio::Workflow.now, non-deterministic gems in workflows
  • Writing Tests: minitest with Temporalio::Testing::WorkflowEnvironment
  • Additional Resources: ruby.temporal.io API docs, samples-ruby repo, Temporal 101 Ruby course

Section content notes:

  • Writing Tests: all languages should be a brief link to references/<lang>/testing.md, NOT inline code examples

Go-specific notes:

  • Go uses exported functions (not decorators) for workflows/activities
  • Activities commonly defined as struct methods for dependency injection
  • Worker setup: worker.New(client, taskQueue, options) + w.RegisterWorkflow / w.RegisterActivity
  • Determinism rules included in Key Concepts subsection (like Python), not separate section
  • Understanding Replay: TS-specific section; Go references core like Python
  • workflowcheck static analysis tool mentioned in Key Concepts (Go-specific)
  • File organization: Go uses separate packages (workflows/, activities/, worker/)

Intentionally missing (—):

  • Core column: no core top-level file (these are language entry points)
  • Determinism Rules — TS has separate section; Python/Go have subsection in Key Concepts
  • Understanding Replay — TS-specific; Python/Go reference core

Order alignment: ✓ Aligned — Ruby follows Python order (no Understanding Replay or Determinism Rules sections)

Style alignment: ✅ Complete (Python, TypeScript, Go). Ruby: ~7 sections planned.

  • Removed "How Temporal Works" from TS (now brief "Understanding Replay" referencing core)
  • Added "File Organization Best Practice" to TS
  • Python Quick Demo and TypeScript Quick Start now match (full tutorial with 4 files, run instructions, expected output)
  • Both Key Concepts and Common Pitfalls sections aligned