Skip to content

Commit 68ebe14

Browse files
authored
Fix typos and broken references across skill docs (#56)
- Fix missing trailing pipe in error-reference.md table header - Fix wrong reference path in go.md (python -> go determinism-protection) - Add missing .md extension to testing reference in go/determinism-protection.md - Fix typos: "Activty" -> "Activity", "accomplised" -> "accomplished", "discourged" -> "discouraged"
1 parent 1cc4591 commit 68ebe14

5 files changed

Lines changed: 6 additions & 6 deletions

File tree

references/core/error-reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Common Error Types Reference
22

3-
| Error Type | Error identifier (if any) | Where to Find | What Happened | Recovery | Link to additional info (if any)
3+
| Error Type | Error identifier (if any) | Where to Find | What Happened | Recovery | Link to additional info (if any) |
44
|------------|---------------|---------------|---------------|----------|----------|
55
| **Non-determinism** | TMPRL1100 | `WorkflowTaskFailed` in history | Replay doesn't match history | Analyze error first. **If accidental**: fix code to match history → restart worker. **If intentional v2 change**: terminate → start fresh workflow. | https://github.com/temporalio/rules/blob/main/rules/TMPRL1100.md |
66
| **Deadlock** | TMPRL1101 | `WorkflowTaskFailed` in history, worker logs | Workflow blocked too long (deadlock detected) | Remove blocking operations from workflow code (no I/O, no sleep, no threading locks). Use Temporal primitives instead. | https://github.com/temporalio/rules/blob/main/rules/TMPRL1101.md |

references/core/patterns.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -253,9 +253,9 @@ To ensure that polling_activity is restarted in a timely manner, we make sure th
253253

254254
**Implementation**:
255255

256-
Define an Activty which fails (raises an exception) exactly when polling is not completed.
256+
Define an Activity which fails (raises an exception) exactly when polling is not completed.
257257

258-
The polling loop is accomplised via activity retries, by setting the following Retry options:
258+
The polling loop is accomplished via activity retries, by setting the following Retry options:
259259
- backoff_coefficient: to 1
260260
- initial_interval: to the polling interval (e.g. 60 seconds)
261261

references/core/troubleshooting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,7 @@ Timeout error?
192192
├─▶ Which timeout?
193193
│ │
194194
│ ├─▶ Workflow timeout
195-
│ │ └─▶ Increase timeout or optimize workflow. Better yet, consider removing the workflow timeout, as it is generally discourged unless *necessary* for your use case.
195+
│ │ └─▶ Increase timeout or optimize workflow. Better yet, consider removing the workflow timeout, as it is generally discouraged unless *necessary* for your use case.
196196
│ │
197197
│ ├─▶ ScheduleToCloseTimeout
198198
│ │ └─▶ Activity taking too long overall (including retries)

references/go/determinism-protection.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Overview
44

5-
The Go SDK has no runtime sandbox. Determinism is enforced by **developer convention** and **optional static analysis**. Unlike the Python and TypeScript SDKs, the Go SDK will not intercept or replace non-deterministic calls at runtime. The Go SDK does perform a limited runtime command-ordering check, but catching non-deterministic code before deployment requires the `workflowcheck` tool and testing, in particular replay tests (see `references/go/testing`).
5+
The Go SDK has no runtime sandbox. Determinism is enforced by **developer convention** and **optional static analysis**. Unlike the Python and TypeScript SDKs, the Go SDK will not intercept or replace non-deterministic calls at runtime. The Go SDK does perform a limited runtime command-ordering check, but catching non-deterministic code before deployment requires the `workflowcheck` tool and testing, in particular replay tests (see `references/go/testing.md`).
66

77
## workflowcheck Static Analysis
88

references/go/go.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -239,4 +239,4 @@ See `references/go/testing.md` for info on writing tests.
239239
- **`references/go/advanced-features.md`** - Schedules, worker tuning, and more
240240
- **`references/go/data-handling.md`** - Data converters, payload codecs, encryption
241241
- **`references/go/versioning.md`** - Patching API (`workflow.GetVersion`), Worker Versioning
242-
- **`references/python/determinism-protection.md`** - Information on **`workflowcheck`** tool to help statically check for determinism issues.
242+
- **`references/go/determinism-protection.md`** - Information on **`workflowcheck`** tool to help statically check for determinism issues.

0 commit comments

Comments
 (0)