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

Update README to enumerate missing Flake8 rules

Browse source
This commit is contained in:
Charlie Marsh 2022-09-12 15:24:32 -04:00
parent 062d7081a0
commit ad7daa008e
1 changed files with 5 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -123,17 +123,15 @@ ruff's goal is to achieve feature-parity with Flake8 when used (1) without any p
(2) alongside Black, and (3) on Python 3 code. (Using Black obviates the need for many of Flake8's (2) alongside Black, and (3) on Python 3 code. (Using Black obviates the need for many of Flake8's
stylistic checks; limiting to Python 3 obviates the need for certain compatibility checks.) stylistic checks; limiting to Python 3 obviates the need for certain compatibility checks.)
Under those conditions, Flake8 implements about 58 rules, give or take. At time of writing, ruff Under those conditions, Flake8 implements about 63 rules, give or take. At time of writing, ruff
implements 36 rules. (Note that these 36 rules likely cover a disproportionate share of errors: implements 36 rules. (Note that these 36 rules likely cover a disproportionate share of errors:
unused imports, undefined variables, etc.) unused imports, undefined variables, etc.)
Of the unimplemented rules, ruff is missing: The 27 unimplemented rules are tracked in #170, and include:
- 15 rules related to string `.format` calls. - 14 rules related to string `.format` calls.
- 3 rules related to syntax errors in doctests and annotations. - 5 rules related to parsing and syntax errors.
- 2 rules related to redefining unused names. - 8 logical rules.
...along with a variety of others that don't fit neatly into any specific category.
Beyond rule-set parity, ruff suffers from the following limitations vis-à-vis Flake8: Beyond rule-set parity, ruff suffers from the following limitations vis-à-vis Flake8: