feat(tsdoc): Don't replace line breaks when emitting comments #443
Conversation
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
Josmithr
commented
Oct 7, 2025
Josmithr
commented
Oct 7, 2025
tsdoc/src/__tests__/__snapshots__/DocNodeTransforms.test.ts.snap
Outdated
Show resolved
Hide resolved
Josmithr
changed the title
Josmithr
changed the title
|
This LGTM but I'm currently traveling, so I'm not able to test it. @iclanton maybe you can try it in the playground? |
Josmithr
commented
Oct 8, 2025
| { | ||
| "packageName": "@microsoft/tsdoc", | ||
| "comment": "Update emitter to not replace line breaks", | ||
| "type": "major" |
There was a problem hiding this comment.
I tagged this as major. I'm assuming we consider a change to the emitted format to be a breaking one.
There was a problem hiding this comment.
This should probably be a minor bump. This isn't a significant behavior change.
Suggested change
| "type": "major" | |
| "type": "minor" |
Josmithr
requested review from
D4N14L,
apostolisms,
dmichon-msft,
iclanton,
octogonz and
patmill
as code owners
Open
|
@Josmithr, can you provide some examples of what this actually changes? Maybe inputs and diffs of the before/after outputs? |
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.
Preserves line breaks when emitting TSDoc comments. Ensures information is not lost.