language-servers/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff.git synced 2025-08-31 07:38:00 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Add preview documentation section (#7281)

Browse source 
Adds a basic documentation section for preview mode based on the FAQ
entry and versioning RFC.
This commit is contained in:
Zanie Blue 2023-09-12 10:43:31 -05:00 • committed by GitHub
parent 5d4dd3e38e
commit 008da95b29
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 50 additions and 36 deletions
Download patch file Download diff file Expand all files Collapse all files

37
docs/faq.md
View file

@ -384,42 +384,7 @@ alone.
## What is preview?
Preview enables a collection of newer rules and fixes that are considered experimental or unstable.
If a rule is marked as preview, it can only be enabled if the `--preview` flag is toggled. For example, consider a
hypothetical rule, `HYP001`. If `HYP001` were in preview, it would _not_ be enabled by adding following to your
`pyproject.toml`:
```toml
[tool.ruff]
extend-select = ["HYP001"]
```
It also would _not_ be enabled by selecting the `HYP` category, like so:
```toml
[tool.ruff]
extend-select = ["HYP"]
```
Similarly, it would _not_ be enabled via the `ALL` selector:
```toml
[tool.ruff]
select = ["ALL"]
```
However, it would be enabled in any of the above cases if you you enabled `preview`:
```toml
[tool.ruff]
extend-select = ["HYP"]
preview = true
```
Preview can also be enabled via the CLI with the `--preview` flag.
To see which rules are currently in preview, visit the [rules reference](https://beta.ruff.rs/docs/rules/).
Preview enables a collection of newer rules and fixes that are considered experimental or unstable. See the [preview documentation](https://beta.ruff.rs/docs/preview/) for more details; or, to see which rules are currently in preview, visit the [rules reference](https://beta.ruff.rs/docs/rules/).
## How can I tell what settings Ruff is using to check my code?

48
docs/preview.md Normal file
View file

@ -0,0 +1,48 @@
# Preview
Ruff includes an opt-in preview mode to provide an opportunity for community feedback and increase confidence that
changes are a net-benefit before enabling them for everyone.
Preview mode enables a collection of newer rules and fixes that are considered experimental or unstable.
## Enabling preview mode
Preview mode can be enabled with the `--preview` flag on the CLI or by setting `preview = true` in your Ruff
configuration file (e.g. `pyproject.toml`).
## Using rules that are in preview
If a rule is marked as preview, it can only be selected if preview mode is enabled. For example, consider a
hypothetical rule, `HYP001`. If `HYP001` were in preview, it would _not_ be enabled by adding following to your
`pyproject.toml`:
```toml
[tool.ruff]
extend-select = ["HYP001"]
```
It also would _not_ be enabled by selecting the `HYP` category, like so:
```toml
[tool.ruff]
extend-select = ["HYP"]
```
Similarly, it would _not_ be enabled via the `ALL` selector:
```toml
[tool.ruff]
select = ["ALL"]
```
However, it would be enabled in any of the above cases if you you enabled preview in your configuration file:
```toml
[tool.ruff]
extend-select = ["HYP"]
preview = true
```
Or, if you provided the `--preview` CLI flag.
To see which rules are currently in preview, visit the [rules reference](https://beta.ruff.rs/docs/rules/).

1
scripts/generate_mkdocs.py
View file

@ -25,6 +25,7 @@ SECTIONS: list[Section] = [
Section("Installation", "installation.md", generated=False),
Section("Usage", "usage.md", generated=False),
Section("Configuration", "configuration.md", generated=False),
Section("Preview", "preview.md", generated=False),
Section("Rules", "rules.md", generated=True),
Section("Settings", "settings.md", generated=True),
Section("Editor Integrations", "editor-integrations.md", generated=False),