Update examples to format first #66
Conversation
It makes more sense to run `ruff` formatter fist, as formatting might change the line numbers, which affect the lines reported by the linter. This is very noticeable when running `ruff` for the first time on a large number of files, as the formatter will change several lines.
|
That's a good observation! Though the existing order is fairly intentional. Our linter-formatter compatibility contract is such that running the formatter should not introduce new lint errors -- so if you format after linting (and you haven't enabled any conflicting rules), you should be guaranteed that linting again doesn't yield any new violations. The inverse is not true. If you run the formatter, then linter with The formatter-linter compatibility docs are here, and the pre-commit setup is documented here. |
|
I see, thanks for the detailed explanation! Closing this then. 👍 |
It makes more sense to run
ruffformatter fist, as formatting might change the line numbers, which affect the lines reported by the linter.This is very noticeable when running
rufffor the first time on a large number of files, as the formatter will change several lines.