mirrors/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff.git synced 2025-10-01 06:11:21 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

Make B024 and B027 documentation more nuanced (#11341)

Browse source 
Closes https://github.com/astral-sh/ruff/issues/11334.
This commit is contained in:
Charlie Marsh 2024-05-08 11:16:58 -04:00 • committed by GitHub
parent caf01472d5
commit 702d2fa1eb
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 8 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

18
crates/ruff_linter/src/rules/flake8_bugbear/rules/abstract_base_class.rs
View file

@ -14,12 +14,12 @@ use crate::registry::Rule;
/// Checks for abstract classes without abstract methods.
///
/// ## Why is this bad?
/// Abstract base classes are used to define interfaces. If they have no abstract
/// methods, they are not useful.
/// Abstract base classes are used to define interfaces. If an abstract base
/// class has no abstract methods, you may have forgotten to add an abstract
/// method to the class or omitted an `@abstractmethod` decorator.
///
/// If the class is not meant to be used as an interface, it should not be an
/// abstract base class. Remove the `ABC` base class from the class definition,
/// or add an abstract method to the class.
/// If the class is _not_ meant to be used as an interface, consider removing
/// the `ABC` base class from the class definition.
///
/// ## Example
/// ```python
@ -62,11 +62,9 @@ impl Violation for AbstractBaseClassWithoutAbstractMethod {
/// decorator.
///
/// ## Why is this bad?
/// Empty methods in abstract base classes without an abstract decorator are
/// indicative of unfinished code or a mistake.
///
/// Instead, add an abstract method decorated to indicate that it is abstract,
/// or implement the method.
/// Empty methods in abstract base classes without an abstract decorator may be
/// be indicative of a mistake. If the method is meant to be abstract, add an
/// `@abstractmethod` decorator to the method.
///
/// ## Example
/// ```python