-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add preview documentation section (#7281)
Adds a basic documentation section for preview mode based on the FAQ entry and versioning RFC.
- Loading branch information
Showing
3 changed files
with
50 additions
and
36 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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/). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters