diff --git a/BREAKING_CHANGES.md b/BREAKING_CHANGES.md index 055796559f..b698be8c0c 100644 --- a/BREAKING_CHANGES.md +++ b/BREAKING_CHANGES.md @@ -209,8 +209,8 @@ This change only affects those using Ruff under its default rule set. Users that ### Remove support for emoji identifiers ([#7212](https://github.com/astral-sh/ruff/pull/7212)) -Previously, Ruff supported the non-standard compliant emoji identifiers e.g. `📦 = 1`. -We decided to remove this non-standard language extension, and Ruff now reports syntax errors for emoji identifiers in your code, the same as CPython. +Previously, Ruff supported non-standards-compliant emoji identifiers such as `📦 = 1`. +We decided to remove this non-standard language extension. Ruff now reports syntax errors for invalid emoji identifiers in your code, the same as CPython. ### Improved GitLab fingerprints ([#7203](https://github.com/astral-sh/ruff/pull/7203)) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e59371c156..15f961e7d8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -526,7 +526,7 @@ cargo benchmark #### Benchmark-driven Development Ruff uses [Criterion.rs](https://bheisler.github.io/criterion.rs/book/) for benchmarks. You can use -`--save-baseline=` to store an initial baseline benchmark (e.g. on `main`) and then use +`--save-baseline=` to store an initial baseline benchmark (e.g., on `main`) and then use `--benchmark=` to compare against that benchmark. Criterion will print a message telling you if the benchmark improved/regressed compared to that baseline. @@ -678,9 +678,9 @@ utils with it: 23 Newline 24 ``` -- `cargo dev print-cst `: Print the CST of a python file using +- `cargo dev print-cst `: Print the CST of a Python file using [LibCST](https://github.com/Instagram/LibCST), which is used in addition to the RustPython parser - in Ruff. E.g. for `if True: pass # comment` everything including the whitespace is represented: + in Ruff. For example, for `if True: pass # comment`, everything, including the whitespace, is represented: ```text Module { diff --git a/docs/faq.md b/docs/faq.md index 4224d1ebb0..d2dde46530 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -639,7 +639,7 @@ making changes to code, even for seemingly trivial fixes. If a "safe" fix breaks Ruff's color output is powered by the [`colored`](https://crates.io/crates/colored) crate, which attempts to automatically detect whether the output stream supports color. However, you can force colors off by setting the `NO_COLOR` environment variable to any value (e.g., `NO_COLOR=1`), or -force colors on by setting `FORCE_COLOR` to any non-empty value (e.g. `FORCE_COLOR=1`). +force colors on by setting `FORCE_COLOR` to any non-empty value (e.g., `FORCE_COLOR=1`). [`colored`](https://crates.io/crates/colored) also supports the `CLICOLOR` and `CLICOLOR_FORCE` environment variables (see the [spec](https://bixense.com/clicolors/)). diff --git a/docs/preview.md b/docs/preview.md index 66a9877b0a..56590c7578 100644 --- a/docs/preview.md +++ b/docs/preview.md @@ -177,7 +177,7 @@ setting in your configuration file: ``` In our previous example, `--select` with `ALL` `HYP`, `HYP0`, or `HYP00` would not enable `HYP001`. Each preview -rule will need to be selected with its exact code, e.g. `--select ALL,HYP001`. +rule will need to be selected with its exact code: for example, `--select ALL,HYP001`. If preview mode is not enabled, this setting has no effect.