Skip to content

Commit e77ac1f

Browse files
update readme
1 parent 0a1234b commit e77ac1f

1 file changed

Lines changed: 16 additions & 0 deletions

File tree

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,18 @@ By default, all lints are enabled except
5151
- [`COM`](https://docs.astral.sh/ruff/rules/#flake8-commas-com) Enforces trailing commas
5252
- [`ERA`](https://docs.astral.sh/ruff/rules/#eradicate-era) Disallows commented-out code
5353
- [`ISC001`](https://docs.astral.sh/ruff/rules/single-line-implicit-string-concatenation/#flake8-executable-exe) (conflicts with the formatter).
54+
- [`PTH`](https://docs.astral.sh/ruff/rules/#flake8-use-pathlib-pth) Requires use of pathlib
55+
- [`TRY003`](https://docs.astral.sh/ruff/rules/raise-vanilla-args/) disallow exception messages as string literals
56+
- [`RUF002`](https://docs.astral.sh/ruff/rules/ambiguous-unicode-character-docstring/) disallow ambiguous characters in docstrings
57+
- [`RUF003`](https://docs.astral.sh/ruff/rules/RUF003/) disallow ambiguous characters in docstrings
58+
- [`PLC0415`](https://docs.astral.sh/ruff/rules/PLC0415/) disallow import outside top level
59+
- [`PD`](https://docs.astral.sh/ruff/rules/#pandas-vet-pd) opinionated linting for `pandas` code
60+
61+
Out of the `PD` rules, the following are reenabled:
62+
63+
- [`PD002`](https://docs.astral.sh/ruff/rules/PD002/) disallow `inplace=True`
64+
- [`PD007`](https://docs.astral.sh/ruff/rules/PD002/) disallow deprecated `.ix`
65+
- [`PD101`](https://docs.astral.sh/ruff/rules/PD002/) disallow `Series.nunique()` for checking a series is constant
5466

5567
In addition, the following rules are only enforced for module code as they are inappropriate or too strict for unit tests and notebooks:
5668

@@ -59,6 +71,10 @@ In addition, the following rules are only enforced for module code as they are i
5971
- [`S101`](https://docs.astral.sh/ruff/rules/assert/) Disallows use of `assert`
6072
- [`PLR2004`](https://docs.astral.sh/ruff/rules/magic-value-comparison/) Disallows "magic" values in comparisons
6173
- [`T20`](https://docs.astral.sh/ruff/rules/#flake8-print-t20) Disallows print statements
74+
- [`EM`](https://docs.astral.sh/ruff/rules/#flake8-errmsg-em) Linting for error messages
75+
- [`PLR0913`](https://docs.astral.sh/ruff/rules/PLR0913) Disallow too many arguments
76+
- [`FBT003`](https://docs.astral.sh/ruff/rules/FBT003) Disallow boolean positional values in call
77+
- [`INP001`](https://docs.astral.sh/ruff/rules/INP001) Disallow implicit namespace packages
6278

6379
The target line length is 120 and the docstring convention is google.
6480

0 commit comments

Comments
 (0)