Fix instability in trailing clause body comments#7556
Merged
charliermarsh merged 1 commit intomainfrom Sep 21, 2023
Merged
Conversation
charliermarsh
added
bug
MichaReiser
approved these changes
Sep 21, 2023
konstin
approved these changes
Sep 21, 2023
charliermarsh
force-pushed
the
charlie/comment
branch
from
61b2ab4 to
4d4c6b6
Compare
charliermarsh
added a commit
that referenced
this pull request
Sep 22, 2023
…rts (#7607) ## Summary Given: ```python # -*- coding: utf-8 -*- import random # Defaults for arguments are defined here # args.threshold = None; logger = logging.getLogger("FastProject") ``` We want to count the number of newlines after `import random`, to ensure that there's _at least one_, but up to two. Previously, we used the end range of the statement (then skipped trivia); instead, we need to use the end of the _last comment_. This is similar to #7556. Closes #7604.
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.
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 testSmall improvement in
transformers, but no regressions.Before:
After: