mirrors/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff.git synced 2025-11-02 21:02:37 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Document link between import sorting and formatter (#9117)

Browse source
This commit is contained in:
Joffrey Bluthé 2023-12-15 11:47:19 +01:00 • committed by GitHub
parent c8d6958d15
commit db38078ca3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

12
docs/formatter.md
View file

@ -392,3 +392,15 @@ flag.
Black promotes some of its preview styling to stable at the end of each year. Ruff will similarly
implement formatting changes under the [`preview`](https://docs.astral.sh/ruff/settings/#preview)
flag, promoting them to stable through minor releases, in accordance with our [versioning policy](https://github.com/astral-sh/ruff/discussions/6998#discussioncomment-7016766).
## Sorting imports
Currently, the Ruff formatter does not sort imports. In order to both sort imports and format,
call the Ruff linter and then the formatter:
```shell
ruff check --select I --fix .
ruff format .
```
A unified command for both linting and formatting is [planned](https://github.com/astral-sh/ruff/issues/8232).