Formatter: Add EmptyWithDanglingComments helper #5951
Merged
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
This was referenced Jul 21, 2023
|
Current dependencies on/for this PR: This comment was auto-generated by Graphite. |
PR Check ResultsBenchmarkLinuxWindows |
MichaReiser
approved these changes
Jul 21, 2023
MichaReiser
reviewed
Jul 21, 2023
| /// ``` | ||
| /// These comments are dangling because they can't be assigned to any element inside as they would | ||
| /// in all other cases. | ||
| pub(crate) fn empty_with_dangling_comments( |
There was a problem hiding this comment.
Nit: Maybe empty_parenthesized_with_dangling_comments
There was a problem hiding this comment.
added this, we need to figure out a better nomenclature for ( vs. {(, [, {}
**Summary** Add a `EmptyWithDanglingComments` format helper that formats comments inside empty parentheses, brackets or curly braces. Previously, this was implemented separately, and partially incorrectly, for each use case.
Empty `()`, `[]` and `{}` are special because there can be dangling comments, and they can be in
two positions:
```python
x = [ # end-of-line
# own line
]
```
These comments are dangling because they can't be assigned to any element inside as they would
in all other cases.
**Test Plan** Added a regression test.
85 (from previously 89) instances of unstable formatting remaining.
```
$ cargo run --bin ruff_dev --release -- format-dev --stability-check --error-file formatter-ecosystem-errors.txt --multi-project target/checkouts > formatter-ecosystem-progress.txt
$ rg "Unstable formatting" target/formatter-ecosystem-errors.txt | wc -l
85
```
konstin
changed the base branch from
no_magic_trailing_commas_for_lambdas
to
main
konstin
force-pushed
the
EmptyWithDanglingComments
branch
from
8d55004 to
c1ead0b
Compare
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.
Summary Add a
EmptyWithDanglingCommentsformat helper that formats comments inside empty parentheses, brackets or curly braces. Previously, this was implemented separately, and partially incorrectly, for each use case.Empty
(),[]and{}are special because there can be dangling comments, and they can be intwo positions:
These comments are dangling because they can't be assigned to any element inside as they would
in all other cases.
Test Plan Added a regression test.
145 (from previously 149) instances of unstable formatting remaining.