Cyclic0007/ruff
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

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
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?