From b371713591b29bdca5d0367222a3e1b1a0916226 Mon Sep 17 00:00:00 2001 From: Charlie Marsh Date: Mon, 13 May 2024 10:27:29 -0400 Subject: [PATCH] Add a note on `--preview` to the README (#11395) --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index e2d2b64b31..015688b7b8 100644 --- a/README.md +++ b/README.md @@ -266,6 +266,11 @@ The remaining configuration options can be provided through a catch-all `--confi ruff check --config "lint.per-file-ignores = {'some_file.py' = ['F841']}" ``` +To opt in to the latest lint rules, formatter style changes, interface updates, and more, enable +[preview mode](https://docs.astral.sh/ruff/rules/) by setting `preview = true` in your configuration +file or passing `--preview` on the command line. Preview mode enables a collection of unstable +features that may change prior to stabilization. + See `ruff help` for more on Ruff's top-level commands, or `ruff help check` and `ruff help format` for more on the linting and formatting commands, respectively.