Skip to content

Commit

Permalink
Add preview documentation section (#7281)
Browse files Browse the repository at this point in the history
Adds a basic documentation section for preview mode based on the FAQ
entry and versioning RFC.
  • Loading branch information
zanieb authored Sep 12, 2023
1 parent 5d4dd3e commit 008da95
Show file tree
Hide file tree
Showing 3 changed files with 50 additions and 36 deletions.
37 changes: 1 addition & 36 deletions docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -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?

Expand Down
48 changes: 48 additions & 0 deletions docs/preview.md
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/).
1 change: 1 addition & 0 deletions scripts/generate_mkdocs.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ class Section(NamedTuple):
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),
Expand Down

0 comments on commit 008da95

Please sign in to comment.