Fix issue with disappearing newlines after multiline documentation comment #77521
+39
−2
Conversation
This file contains 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
dotnet-issue-labeler
bot
added
Area-Compilers
untriaged
dotnet-policy-service
bot
added
the
Community
|
@dotnet-policy-service agree |
333fred
reviewed
Mar 11, 2025
|
@dgounaris can you update your comment to specifically say "fixes |
|
@333fred Thanks for the review, addressed the comments, feel free to have a look. |
333fred
approved these changes
Mar 13, 2025
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.
This PR fixes #76856, where multi-line doc comments ending in a newline would have the newline disappearing afterwards.
Based on my investigation, the situation can be described as follows:
RewriteTriviaskips newline tokens.NeedsLineBreakAftercall can't be the target for this fix, because not every comment needs a new line after it. Wider context is needed.EndsInLineBreakcan be true for the doc token in cases where in reality the documentation end token is the ending token, due to the 0 width of theEndOfDocumentationCommentTokentype.The proposed fix adds a linebreak if the leading SyntaxToken is a multiline documentation ending in linebreak, and forces it to be retained during rewriting by slightly modifying
EndsInLineBreaktoo.As this is my first time contributing, let me know if I have not grasped the codebase correctly and there is a cleaner way to apply this.