fix: preserve indentation around XML comment code blocks - #11143
Merged
Merged
Conversation
Keep newly inserted separators aligned with adjacent siblings and enclosing elements so normal Markdown is not parsed as indented code. Add rendered HTML regressions for compact block tags, nested examples and lists. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: bf666f99-8d30-4763-878d-b566c0ac2f2d
vwxyzh
approved these changes
Sep 18, 2026
This was referenced Sep 18, 2026
This was referenced Sep 19, 2026
This was referenced Sep 19, 2026
This was referenced Sep 25, 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
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.
Summary
Follow-up to #10966. Keep the indentation when inserting blank lines between adjacent block elements and around inline child elements. Reuse the existing indentation helper, extending its search to the enclosing element when the child has no preceding newline of its own.
The separators previously inserted as bare
\n\ncreated a zero-indented line. Common-indent removal then left the surrounding XML documentation indentation in place, so Markdown paragraphs became indented code blocks. Compact nested examples and lists had the same problem.Reproduction
After #10966, the last line renders as
<pre><code>After **bold**...</code></pre>instead of<p>After <strong>bold</strong>.</p>. The follow-up preserves the intended paragraph and the actual code block.Validation
Docfx.Dotnet.Teststests pass on .NET 10, including the original fix: XML comment parse logics for block element that is adjacent to markdown content #10966 cases, with zero skips.git diff --checkpass.8cddf17d90e4cfd8b9f2288662cd3142810eebc4; only these two files differ. No dependency or workflow changes.