Fix non-idempotent indentation of consecutive block comments - #7103
Open
saberoueslati wants to merge 1 commit into
Open
Fix non-idempotent indentation of consecutive block comments#7103saberoueslati wants to merge 1 commit into
saberoueslati wants to merge 1 commit into
Conversation
rustbot
added
the
S-waiting-on-review
| .find(|rev_c| ![' ', '\t'].contains(rev_c)); | ||
|
|
||
| let fix_indent = last_char.map_or(true, |rev_c| ['{', '\n'].contains(&rev_c)); | ||
| let starts_output_line = !self.buffer.is_empty() && self.buffer.ends_with('\n'); |
Contributor
There was a problem hiding this comment.
I'm not sure I understand this fix from a glance, can you explain what is the importance of self.buffer ending in a newline?
Author
There was a problem hiding this comment.
self.buffer ending in \n means the next comment starts a new output line. For /*A*/ /*B*/, writing /*A*/ adds a newline via the _ => arm at the end of process_comment. But last_char still sees the closing / of /*A*/ in the original source, so fix_indent is false and /*B*/ gets one space instead of the block indent. starts_output_line catches this and applies self.block_indent on the first pass, so reformatting no longer changes the output.
I hope this clears it up
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
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.
Context
process_commentdetermined indentation only from the original source. For/*A*/ /*B*/, formatting the first comment added a newline, but the second was still treated as inline and indented by one space, requiring another pass to converge.The fix also checks whether the output buffer ends with a newline. If so, the comment receives
self.block_indent. Genuine trailing comments and already-canonical output remain unchanged, so no style-edition gate is needed.Tests
Added source and target regression tests covering consecutive comments, nested blocks, comments between statements, trailing comments, and canonical input.
Closes #7019
Used an LLM to better understand the code surrounding the changes and the issue. Changes made by me