fix: remove multiple trailing lines in comments #6163
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
overhacked
force-pushed
the
overhacked/remove_multiple_comment_trailing_lines
branch
from
2df498f
to
fd95d0f
Compare
|
@overhacked thanks for the PR. Would you mind also filing an issue for this too. |
ytmimi
reviewed
Jul 16, 2024
ytmimi
reviewed
Jul 16, 2024
Previously, rustfmt would remove one blank, trailing line in a comment every time it ran, so formatting was not idempotent if a comment had multiple trailing lines. Comments are only reformatted in this way if `comment::rewrite_comment_inner` is called, which is enabled by any of the config options `normalize_comments`, `wrap_comments`, or `format_code_in_doc_comments` (for doc comments only). Absent those config options, no trailing line reformatting occurs at all. In this commit, when the existing condition that detects a blank, trailing line is true, any preceding blank lines are removed from the reformatted comment. A source/target "system test" was added to prevent regression. Signed-off-by: Ross Williams <[email protected]>
Block comments with bare lines are handled differently than those without bare lines (unless `normalize_comments` is configured). If `normalize_comments` is false but `wrap_comments` is true, trailing blank lines should be removed from block comments, including those with bare lines. Signed-off-by: Ross Williams <[email protected]>
overhacked
force-pushed
the
overhacked/remove_multiple_comment_trailing_lines
branch
from
5a70671
to
f66d7d8
Compare
|
@ytmimi, pushed some commits that address your review comments. Now block comments with bare lines can also have their trailing blank lines stripped. Thanks! |
|
Great! I appreciate you looking into that. I know this has been open for a while and it'll be a bit longer before I'm able to take another look at this since the team's top priority right now is completing the work around style edition 2024. I'll follow up once I'm able to review this. |
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.
Previously, rustfmt would remove one blank, trailing line in a comment every time it ran, so formatting was not idempotent if a comment had multiple trailing lines. Comments are only reformatted in this way if
comment::rewrite_comment_inneris called, which is enabled by any of the config optionsnormalize_comments,wrap_comments, orformat_code_in_doc_comments(for doc comments only). Absent those config options, no trailing line reformatting occurs at all.In this fix, when the existing condition that detects a blank, trailing line is true, any preceding blank lines are removed from the reformatted comment. A source/target "system test" was added to prevent regression.