diff --git a/README.md b/README.md index ace80d9874..4552e4efca 100644 --- a/README.md +++ b/README.md @@ -717,11 +717,11 @@ By default, Ruff enables Flake8's `E` and `F` rules. Ruff supports all rules fro and a [subset](#error-e) of the `E` category, omitting those stylistic rules made obsolete by the use of an autoformatter, like [Black](https://github.com/psf/black). -The 🛠 emoji indicates that a rule is automatically fixable by the `--fix` command-line option. - +The 🛠 emoji indicates that a rule is automatically fixable by the `--fix` command-line option. + ### Pyflakes (F) For more, see [Pyflakes](https://pypi.org/project/pyflakes/) on PyPI. diff --git a/crates/ruff_dev/src/generate_rules_table.rs b/crates/ruff_dev/src/generate_rules_table.rs index 8f1fec7e05..179a251a90 100644 --- a/crates/ruff_dev/src/generate_rules_table.rs +++ b/crates/ruff_dev/src/generate_rules_table.rs @@ -14,6 +14,7 @@ const TABLE_END_PRAGMA: &str = ""; const TOC_BEGIN_PRAGMA: &str = ""; const TOC_END_PRAGMA: &str = ""; +const FIX_SYMBOL: &str = "🛠"; const URL_PREFIX: &str = "https://beta.ruff.rs/docs/rules"; #[derive(clap::Args)] @@ -31,7 +32,7 @@ fn generate_table(table_out: &mut String, rules: impl IntoIterator, for rule in rules { let fix_token = match rule.autofixable() { None => "", - Some(_) => "🛠", + Some(_) => FIX_SYMBOL, }; let rule_name = rule.as_ref(); @@ -55,7 +56,7 @@ fn generate_table(table_out: &mut String, rules: impl IntoIterator, pub fn main(args: &Args) -> Result<()> { // Generate the table string. - let mut table_out = String::new(); + let mut table_out = format!("The {FIX_SYMBOL} emoji indicates that a rule is automatically fixable by the `--fix` command-line option.\n\n"); let mut toc_out = String::new(); for linter in Linter::iter() { let codes_csv: String = match linter.common_prefix() {