Skip to content

Commit 2b8b1ef

Browse files
authored
Improve docs for some pycodestyle rules (#14517)
1 parent 2efa3fb commit 2b8b1ef

File tree

2 files changed

+4
-3
lines changed

2 files changed

+4
-3
lines changed

crates/ruff_linter/src/rules/pycodestyle/rules/line_too_long.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ use crate::settings::LinterSettings;
1212
/// ## Why is this bad?
1313
/// Overlong lines can hurt readability. [PEP 8], for example, recommends
1414
/// limiting lines to 79 characters. By default, this rule enforces a limit
15-
/// of 88 characters for compatibility with Black, though that limit is
16-
/// configurable via the [`line-length`] setting.
15+
/// of 88 characters for compatibility with Black and the Ruff formatter,
16+
/// though that limit is configurable via the [`line-length`] setting.
1717
///
1818
/// In the interest of pragmatism, this rule makes a few exceptions when
1919
/// determining whether a line is overlong. Namely, it:

crates/ruff_linter/src/rules/pycodestyle/rules/logical_lines/space_around_operator.rs

+2-1
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,8 @@ impl AlwaysFixableViolation for TabAfterComma {
169169
/// Checks for extraneous whitespace after a comma.
170170
///
171171
/// ## Why is this bad?
172-
/// According to the `black` code style, commas should be followed by a single space.
172+
/// Consistency is good. This rule helps ensure you have a consistent
173+
/// formatting style across your project.
173174
///
174175
/// ## Example
175176
/// ```python

0 commit comments

Comments
 (0)