Skip to content

📝 Fix v4 upgrade guide output and code rendering - #1260

Merged
cowboyd merged 1 commit into
v4from
codex/fix-v4-upgrade-guide
Oct 3, 2026
Merged

cowboyd merged 1 commit into
v4from
codex/fix-v4-upgrade-guide

Conversation

@taras

@taras taras commented Oct 3, 2026

Copy link
Copy Markdown
Member

Motivation

The v4 upgrade guide shows parent: end before child: end even though the child sleeps for 10 ms and the parent sleeps for 100 ms. Its code blocks also display literal { and } entities because an unclosed inline-code backtick causes the MDX preprocessor to escape braces inside subsequent examples.

Fixes #1259.

Approach

  • Correct the final two lines of the v3 and v4 output examples.
  • Explain that a child can resume while its parent is suspended, and change the prose's sleep(1) reference to the example's sleep(100).
  • Close the Function.prototype.call() inline-code span so the examples render with literal braces.

Validation: ran the example against Effection 3.6.1 and 4.2.0; both outputs match the corrected guide. Reproduced the brace corruption before the edit, then verified that all 13 rendered code blocks match their source exactly after the edit. deno lint and git diff --check pass. deno fmt docs/upgrade.mdx reports no target files because Deno does not format .mdx files.

@pkg-pr-new

pkg-pr-new Bot commented Oct 3, 2026

Copy link
Copy Markdown

Open in StackBlitz

npm i https://pkg.pr.new/effection@1260

commit: 69d2037

@codspeed

codspeed Bot commented Oct 3, 2026

Copy link
Copy Markdown

Merging this PR will improve performance by 10.13%

⚡ 1 improved benchmark
✅ 5 untouched benchmarks

Performance Changes

Mode Benchmark BASE HEAD Efficiency
⚡ Memory effection-inline.recursion 5.4 KB 4.9 KB +10.13%

Tip

Curious why performance improved? Comment @codspeedbot explain why performance improved on this PR, or directly use the CodSpeed MCP with your agent.


Comparing codex/fix-v4-upgrade-guide (69d2037) with v4 (67bb5b4)

Open in CodSpeed

@taras
taras requested a review from cowboyd October 3, 2026 11:53
@github-actions

github-actions Bot commented Oct 3, 2026 •

Copy link
Copy Markdown
Contributor

🚀 Deploy Preview Ready!

Effection is a structured concurrency and effects framework for JavaScript.
Effection is a structured concurrency and effects framework for JavaScript.

@cowboyd
cowboyd merged commit e3a419f into v4 Oct 3, 2026
19 checks passed
@cowboyd
cowboyd deleted the codex/fix-v4-upgrade-guide branch October 3, 2026 16:33

This branch was successfully deployed

1 active deployment
Preview — 69d2037d Deployed Oct 3, 2026 by taras via deploy-preview #1425
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

v4 升级指南的示例输出与我的实测不一致,想确认 child: end 的位置

2 participants