ruff/docs
Steven DeMartini d7144d6d8e
Fix docs typo for `ruff format` preview configuration (#8611)
## 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).
2023-11-11 03:07:32 +00:00
..
.overrides/partials/integrations/analytics Move some MkDocs responsibilities around (#5542) 2023-07-05 22:06:01 +00:00
assets Update docs to match updated logo and color palette (#5283) 2023-06-22 11:19:34 -04:00
formatter Document context manager breaking deviation vs. Black (#8597) 2023-11-10 04:32:29 +00:00
stylesheets Improve detail link contrast in dark mode (#8548) 2023-11-07 21:41:34 +00:00
.gitignore Fix gitignore to not ignore files that are required (#7538) 2023-09-21 21:33:09 +02:00
configuration.md Add missing config tabs (#8558) 2023-11-09 01:49:06 +00:00
faq.md Fix permalink to convention setting (#8575) 2023-11-09 04:50:32 +00:00
formatter.md Added tabs for configuration files in the documentation (#8480) 2023-11-05 17:10:29 +00:00
installation.md Rework the documentation to incorporate the Ruff formatter (#7732) 2023-10-20 23:08:26 +00:00
integrations.md Prepare release 0.1.5 (#8570) 2023-11-08 16:00:57 -06:00
linter.md Added tabs for configuration files in the documentation (#8480) 2023-11-05 17:10:29 +00:00
preview.md Fix docs typo for `ruff format` preview configuration (#8611) 2023-11-11 03:07:32 +00:00
requirements-insiders.txt Upgrade `PyYAML` to `6.0.1` to avoid build error (#8460) 2023-11-03 10:41:30 +05:30
requirements.txt Upgrade `PyYAML` to `6.0.1` to avoid build error (#8460) 2023-11-03 10:41:30 +05:30
tutorial.md Apply consistent code block labels (#8563) 2023-11-09 01:49:24 +00:00
versioning.md Add note about scope of rule changing in versioning policy (#8169) 2023-10-24 11:38:31 -05:00