Improve documentation around linter-formatter conflicts (#8257)

Closes https://github.com/astral-sh/ruff/issues/8245.
This commit is contained in:
Charlie Marsh 2023-10-26 10:19:16 -07:00 committed by GitHub
parent c32f943d86
commit 63a5a12a41
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 18 additions and 3 deletions

View file

@ -55,6 +55,10 @@ or isort, _unless_ you enable autofix, in which case, Ruff's pre-commit hook sho
Black, isort, and other formatting tools, as Ruff's autofix behavior can output code changes that
require reformatting.
As long as your Ruff configuration avoids any [linter-formatter incompatibilities](formatter.md#conflicting-lint-rules),
`ruff format` should never introduce new lint errors, so it's safe to run Ruff's format hook _after_
`ruff check --fix`.
## Language Server Protocol (Official)
Ruff supports the [Language Server Protocol](https://microsoft.github.io/language-server-protocol/)