Skip to content

Commit

Permalink
Improve docs for some pycodestyle rules (#14517)
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexWaygood authored Nov 21, 2024
1 parent 2efa3fb commit 2b8b1ef
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 2b8b1ef

Please sign in to comment.