mirrors/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff.git synced 2025-09-09 20:06:39 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Add a note on line-too-long to the formatter docs (#8314)

Browse source 
Suggested here:
https://github.com/astral-sh/ruff/discussions/7310#discussioncomment-7410638.
This commit is contained in:
Charlie Marsh 2023-10-28 19:25:38 -07:00 • committed by GitHub
parent 317b6e8682
commit f2f2e759c7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 14 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

14
docs/faq.md
View file

@ -3,16 +3,18 @@
## Is the Ruff linter compatible with Black? ## Is the Ruff linter compatible with Black?
Yes. The Ruff linter is compatible with [Black](https://github.com/psf/black) out-of-the-box, as Yes. The Ruff linter is compatible with [Black](https://github.com/psf/black) out-of-the-box, as
long as the `line-length` setting is consistent between the two. long as the [`line-length`](settings.md#line-length) setting is consistent between the two.
Ruff is designed to be used alongside a formatter (like Ruff's own formatter, or Black) and, as Ruff is designed to be used alongside a formatter (like Ruff's own formatter, or Black) and, as
such, will defer implementing stylistic rules that are obviated by automated formatting. such, will defer implementing stylistic rules that are obviated by automated formatting.
Note that Ruff and Black treat line-length enforcement a little differently. Black makes a Note that Ruff's linter and Black treat line-length enforcement a little differently. Black, like
best-effort attempt to adhere to the `line-length`, but avoids automatic line-wrapping in some cases Ruff's formatter, makes a best-effort attempt to adhere to the
(e.g., within comments). Ruff, on the other hand, will flag rule `E501` for any line that exceeds [`line-length`](settings.md#line-length), but avoids automatic line-wrapping in some cases (e.g.,
the `line-length` setting. As such, if `E501` is enabled, Ruff can still trigger line-length within comments). Ruff, on the other hand, will flag [`line-too-long`](rules/line-too-long.md)
violations even when Black is enabled. (`E501`) for any line that exceeds the [`line-length`](settings.md#line-length) setting. As such, if
[`line-too-long`](rules/line-too-long.md) (`E501`) is enabled, Ruff can still trigger line-length
violations even when Black or `ruff format` is enabled.
## How does Ruff's formatter compare to Black? ## How does Ruff's formatter compare to Black?

7
docs/formatter.md
View file

@ -183,7 +183,7 @@ some rules that, when enabled, can cause conflicts with the formatter, leading t
behavior. When configured appropriately, the goal of Ruff's formatter-linter compatibility is behavior. When configured appropriately, the goal of Ruff's formatter-linter compatibility is
such that running the formatter should never introduce new lint errors. such that running the formatter should never introduce new lint errors.
As such, when using Ruff as a formatter, we recommend avoiding the following lint rules: When using Ruff as a formatter, we recommend avoiding the following lint rules:
- [`tab-indentation`](rules/tab-indentation.md) (`W191`) - [`tab-indentation`](rules/tab-indentation.md) (`W191`)
- [`indentation-with-invalid-multiple`](rules/indentation-with-invalid-multiple.md) (`E111`) - [`indentation-with-invalid-multiple`](rules/indentation-with-invalid-multiple.md) (`E111`)
@ -200,6 +200,11 @@ As such, when using Ruff as a formatter, we recommend avoiding the following lin
- [`single-line-implicit-string-concatenation`](rules/single-line-implicit-string-concatenation.md) (`ISC001`) - [`single-line-implicit-string-concatenation`](rules/single-line-implicit-string-concatenation.md) (`ISC001`)
- [`multi-line-implicit-string-concatenation`](rules/multi-line-implicit-string-concatenation.md) (`ISC002`) - [`multi-line-implicit-string-concatenation`](rules/multi-line-implicit-string-concatenation.md) (`ISC002`)
While the [`line-too-long`](rules/line-too-long.md) (`E501`) rule _can_ be used alongside the
formatter, the formatter only makes a best-effort attempt to wrap lines at the configured
[`line-length`](settings.md#line-length). As such, formatted code _may_ exceed the line length,
leading to [`line-too-long`](rules/line-too-long.md) (`E501`) errors.
None of the above are included in Ruff's default configuration. However, if you've enabled None of the above are included in Ruff's default configuration. However, if you've enabled
any of these rules or their parent categories (like `Q`), we recommend disabling them via the any of these rules or their parent categories (like `Q`), we recommend disabling them via the
linter's [`ignore`](settings.md#ignore) setting. linter's [`ignore`](settings.md#ignore) setting.