fix: preserve mixed-fence code blocks in doc rendering#22350
Open
MavenRain wants to merge 2 commits into
Open
Conversation
`format_docs_` was toggling `in_code_block` whenever any RUSTDOC_FENCES prefix appeared, so a `~~~` line inside a ```-opened block would close the block prematurely (and a ``` line inside a ~~~-opened block would do the same). Track which fence opened the current block in `current_fence: Option<&'static str>` and only close on the matching fence. Closes rust-lang#13815. Signed-off-by: Onyeka Obi <softwareengineerasaservant@isurvivable.cv>
rustbot
added
the
S-waiting-on-review
ChayimFriedman2
requested changes
May 15, 2026
Contributor
There was a problem hiding this comment.
You didn't integrate the suggested changes in #13850 (comment), which is the reason that PR got closed.
Use `pulldown-cmark` to delimit fenced code blocks instead of the hand-rolled line-prefix matcher. Per @ChayimFriedman2's review on rust-lang#22350 (referencing @lowr's earlier note on rust-lang#13850), this brings `format_docs_` in line with the full CommonMark spec: variable-length fences, mixed fence characters (``` vs ~~~), and fences nested inside other block constructs. `format_docs_` now collects fenced code block byte ranges via `Parser::into_offset_iter()` and transforms only inside those ranges (rust-info rewrite, `#`-line stripping, `##`-escape unwrapping), leaving the surrounding markdown byte-for-byte. Closes rust-lang#13815. Signed-off-by: Onyeka Obi <softwareengineerasaservant@isurvivable.cv>
Contributor
Author
I updated to use pulldown-cmark per @lowr's #13850 (comment). Thanks for the pointer. |
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
3 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.
Resurrects the fix that #13850 attempted in 2023 before being closed for inactivity.
format_docs_was treating ``` and ~~~ as interchangeable fences, so a literal~~~line inside a ```-opened block closed the block early (and the mirror case for ```-inside- ~~~). Tracks the opening fence and closes only on a match.Closes #13815.