mirrors/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff.git synced 2025-08-04 18:58:04 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Fix docs typo for ruff format preview configuration (#8611)

Browse source 
## Summary

The ruff configuration section is called "format", rather than
"preview". Using the configuration as it was written in the docs gives
an error:

```
$ ruff format --check .
ruff failed
  Cause: TOML parse error at line 143, column 1
    |
143 | [tool.ruff.preview]
    | ^^^^^^^^^^^^^^^^^^^
invalid type: map, expected a boolean
```

## Test Plan

Tested running `ruff format` with the following in my `pyproject.toml`:

```toml
[tool.ruff.format]
preview = true
```

and it worked properly (using preview rules for formatting).
This commit is contained in:
Steven DeMartini 2023-11-10 19:07:32 -08:00 • committed by GitHub
parent 39728a1198
commit d7144d6d8e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/preview.md
View file

@ -32,14 +32,14 @@ To enable preview style formatting without enabling any preview lint rules:
=== "pyproject.toml"
```toml
[tool.ruff.preview]
[tool.ruff.format]
preview = true
```
=== "ruff.toml"
```toml
[preview]
[format]
preview = true
```