From 2b8b1ef1781fddc89ab67765d855879f28607dae Mon Sep 17 00:00:00 2001 From: Alex Waygood Date: Thu, 21 Nov 2024 17:26:06 +0000 Subject: [PATCH] Improve docs for some pycodestyle rules (#14517) --- .../ruff_linter/src/rules/pycodestyle/rules/line_too_long.rs | 4 ++-- .../pycodestyle/rules/logical_lines/space_around_operator.rs | 3 ++- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/crates/ruff_linter/src/rules/pycodestyle/rules/line_too_long.rs b/crates/ruff_linter/src/rules/pycodestyle/rules/line_too_long.rs index 54b1bf09fd15f..fe1d1b089a60f 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/rules/line_too_long.rs +++ b/crates/ruff_linter/src/rules/pycodestyle/rules/line_too_long.rs @@ -12,8 +12,8 @@ use crate::settings::LinterSettings; /// ## Why is this bad? /// Overlong lines can hurt readability. [PEP 8], for example, recommends /// limiting lines to 79 characters. By default, this rule enforces a limit -/// of 88 characters for compatibility with Black, though that limit is -/// configurable via the [`line-length`] setting. +/// of 88 characters for compatibility with Black and the Ruff formatter, +/// though that limit is configurable via the [`line-length`] setting. /// /// In the interest of pragmatism, this rule makes a few exceptions when /// determining whether a line is overlong. Namely, it: diff --git a/crates/ruff_linter/src/rules/pycodestyle/rules/logical_lines/space_around_operator.rs b/crates/ruff_linter/src/rules/pycodestyle/rules/logical_lines/space_around_operator.rs index 14ad262840524..09c3a97a92263 100644 --- a/crates/ruff_linter/src/rules/pycodestyle/rules/logical_lines/space_around_operator.rs +++ b/crates/ruff_linter/src/rules/pycodestyle/rules/logical_lines/space_around_operator.rs @@ -169,7 +169,8 @@ impl AlwaysFixableViolation for TabAfterComma { /// Checks for extraneous whitespace after a comma. /// /// ## Why is this bad? -/// According to the `black` code style, commas should be followed by a single space. +/// Consistency is good. This rule helps ensure you have a consistent +/// formatting style across your project. /// /// ## Example /// ```python