fix: Preserve @example titles - #476
Open
Josmithr wants to merge 2 commits into
Open
Conversation
Contributor
Author
|
@octogonz I took a stab at resolving microsoft/rushstack#4860. Would love your feedback when you have a moment. |
Josmithr
marked this pull request as ready for review
July 30, 2026 00:08
Josmithr
requested review from
apostolisms,
bmiddha,
dmichon-msft,
iclanton,
jxanthony and
octogonz
as code owners
July 30, 2026 00:08
@example titles@example titles
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
Per TSDoc's documented spec, text on the same line as an
@exampletag is considered the title for the example. The parser previously discarded it. This PR parses the title, exposes it on the AST, and preserves it on round-trip emission.Round-tripping an
@exampleblock would previously result in the title context being lost. It is now preserved.(incorrect line formatting)
(preserves necessary line formatting)
Changes
DocExampleBlocknode with atitle. Registered inDocNodeKind,BuiltInDocNodes, and exported.@examplenow captures the same-line text as the title and routes the rest into the content section.Notes