Fix instability in trailing clause body comments #7556
Merged
+138
−2
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
When we format the trailing comments on a clause body, we check if there are any newlines after the last statement; if not, we insert one.
This logic didn't take into account that the last statement could itself have trailing comments, as in:
We were thus inserting a newline after the comment, like:
In the context of function definitions, this led to an instability, since we insert a newline after a function, which would in turn lead to the bug above appearing in the second formatting pass.
Closes #7465.
Test Plan
cargo test
Small improvement in
transformers
, but no regressions.Before:
After: