[4068] Fix: --line-ranges dedents a # fmt: off in the middle of a decorator #4084
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
|
Thanks! cc @yilei |
|
Thank you for the PR, the change looks good to me. (My original thought would be to add extra info in the |
CHANGES.md
Outdated
| @@ -8,7 +8,8 @@ | |||
|
|
|||
| ### Stable style | |||
|
|
|||
| <!-- Changes that affect Black's stable style --> | |||
| - Fix bug where `# fmt: off` automatically dedents even when it is not within the | |||
There was a problem hiding this comment.
Suggested change
| - Fix bug where `# fmt: off` automatically dedents even when it is not within the | |
| - Fix bug where `# fmt: off` automatically dedents when used with the `--line-ranges` option even when it is not within the |
It's good to explicitly mention the name of the option, especially since it is new.
There was a problem hiding this comment.
Thank you for bringing it to my attention. I will make sure to take note of it
There was a problem hiding this comment.
The requested modifications above have been completed.
JelleZijlstra
approved these changes
Dec 4, 2023
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.
Description
When transforming
fmt:offinto standalone comments, a new node is generated forfmt:off, and in this procedure, the initial indentation offmt:offis not retained. Black code consistently convertsfmt:off/oninto standalone comments before proceeding with additional formatting. Consequently, the formatting offmt:offis disrupted, even when it is not within the specified line range.I addressed this issue by retaining the indentation of
fmt:offand incorporating it into the prefix of the new nodeAdditionally, I observed that black consistently formats comments, regardless of whether
fmt:offis present or if the comments fall outside the specified line range.I refrained from raising an issue for this because I was uncertain whether it was intended behaviour or not.
Fixes: #4068
Checklist
CHANGES.mdif necessary?