Fix Markdown docs with source-like syntax - #1673
Merged
alexcrichton merged 1 commit intoJul 30, 2026
Merged
Conversation
alexcrichton
approved these changes
Jul 30, 2026
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
2 participants
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.
Fixes #1480.
Markdown doc text was passed through
Source::push_str, which treats braces as generated-code structure. A doc line beginning with}could therefore reduce the tracked indentation before thesurrounding documentation block was deindented, causing an overflow panic.
Add a literal append path that preserves indentation without interpreting source syntax, use it for Markdown documentation, and cover the reported input with regression tests.
Tests
cargo test -p wit-bindgen-core -p wit-bindgen-markdowncargo clippy -p wit-bindgen-core -p wit-bindgen-markdown --all-targets -- -D warningscargo fmt --all -- --check