📝 Fix v4 upgrade guide output and code rendering - #1260
Merged
Merged
Conversation
commit: |
Merging this PR will improve performance by 10.13%
Performance Changes
Tip Curious why performance improved? Comment Comparing |
Contributor
|
🚀 Deploy Preview Ready!
|
cowboyd
approved these changes
Oct 3, 2026
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
The v4 upgrade guide shows
parent: endbeforechild: endeven 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
sleep(1)reference to the example'ssleep(100).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 lintandgit diff --checkpass.deno fmt docs/upgrade.mdxreports no target files because Deno does not format.mdxfiles.