Skip to content

Commit 6c88b3c

Browse files
Benoit Traversclaude
authored andcommitted
docs: keep inline code spans on one line
The changeset's `tapErrCases` bullet had an unindented continuation line, which markdown renders as a new paragraph, breaking the list. Cause: the inline code span `[the branch's cause, the observed error]` wrapped across lines, and oxfmt strips the continuation indent there — leading whitespace is significant inside a code span, so reflowing it would alter the span's text. The indent was correct as written and the formatter removed it. Reworded so the span no longer wraps; re-running oxfmt now leaves the indentation alone. Swept the rest of the docs for the same shape and found two more (upgrade-to-v8.md, why-temporal-contract.md). Neither sat in a list, so both rendered fine, but they carried the same latent hazard — reworded too. A backtick-parity scan over all authored markdown is now clean. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
1 parent a54a2f3 commit 6c88b3c

3 files changed

Lines changed: 10 additions & 9 deletions

File tree

.changeset/bump-unthrown-beta-7.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ Two changes come with it, neither requiring code changes here:
1313
the branch returns. Available on all five `*ErrCases` combinators, `match`'s
1414
`errCases` handler, and standalone `match(value)`.
1515
- **`tapErrCases` no longer silently drops a `defect(…)` branch.** Such a branch
16-
now produces a `Defect` carrying an `AggregateError` of `[the branch's cause,
17-
the observed error]`, matching what a `throw` in the same position already
18-
did. Only a breaking change for code that relied on the value being discarded
19-
— this package's single `tapErrCases` call site logs and does not use the
20-
`defect` marker.
16+
now produces a `Defect` whose cause is an `AggregateError` of the branch's
17+
cause and the observed error, matching what a `throw` in the same position
18+
already did. Only a breaking change for code that relied on the value being
19+
discarded — this package's single `tapErrCases` call site logs and does not
20+
use the `defect` marker.

docs/explanation/why-temporal-contract.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -112,8 +112,8 @@ or charges wrongly, and leaves a failed execution to explain.
112112
## Failures as values
113113

114114
Temporal's failure model is strings: an `ApplicationFailure` with a `type` that
115-
retry policies match on. Effective for retries, weak for branching. `if
116-
(error.type === "CARD_DECLINED")` is a stringly-typed conditional with a typo
115+
retry policies match on. Effective for retries, weak for branching. A check like
116+
`error.type === "CARD_DECLINED"` is a stringly-typed conditional with a typo
117117
waiting to happen, and no payload beyond a message.
118118

119119
A contract can declare its failures:

docs/how-to/upgrade-to-v8.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,9 @@ Version 8 has two breaking changes:
1010
Both are mechanical. Budget an afternoon for a medium codebase.
1111

1212
::: warning 8.0 is currently a prerelease
13-
The 8.0 line is published under the `beta` tag. `npm install
14-
@temporal-contract/contract` still resolves 7.x. Install explicitly:
13+
The 8.0 line is published under the `beta` tag, so a plain
14+
`npm install @temporal-contract/contract` still resolves 7.x. Install
15+
explicitly:
1516

1617
```bash
1718
pnpm add @temporal-contract/contract@beta @temporal-contract/worker@beta \

0 commit comments

Comments
 (0)