mirrors/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff.git synced 2025-08-04 10:48:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3
ruff/docs/preview.md
Charlie Marsh 9b43162cc4
Move documentation to docs.astral.sh/ruff (#7419) 
## Summary

We're planning to move the documentation from
[https://beta.ruff.rs/docs](https://beta.ruff.rs/docs) to
[https://docs.astral.sh/ruff](https://docs.astral.sh/ruff), for a few
reasons:

1. We want to remove the `beta` from the domain, as Ruff is no longer
considered beta software.
2. We want to migrate to a structure that could accommodate multiple
future tools living under one domain.

The docs are actually already live at
[https://docs.astral.sh/ruff](https://docs.astral.sh/ruff), but later
today, I'll add a permanent redirect from the previous to the new
domain. **All existing links will continue to work, now and in
perpetuity.**

This PR contains the code changes necessary for the updated
documentation. As part of this effort, I moved the playground and
documentation from my personal Cloudflare account to our team Cloudflare
account (hence the new `--project-name` references). After merging, I'll
also update the secrets on this repo.
2023-09-15 22:49:42 -04:00

1.3 KiB
Raw Blame History

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:

[tool.ruff]
extend-select = ["HYP001"]

It also would not be enabled by selecting the HYP category, like so:

[tool.ruff]
extend-select = ["HYP"]

Similarly, it would not be enabled via the ALL selector:

[tool.ruff]
select = ["ALL"]

However, it would be enabled in any of the above cases if you you enabled preview in your configuration file:

[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.