Tweak message

astral-sh · Mar 17, 2024 · f404f62 · f404f62
1 parent 5d09a08
commit f404f62
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 7 deletions.
diff --git a/crates/ruff_linter/src/rules/pylint/rules/singledispatchmethod_function.rs b/crates/ruff_linter/src/rules/pylint/rules/singledispatchmethod_function.rs
@@ -9,10 +9,12 @@ use crate::checkers::ast::Checker;
 use crate::importer::ImportRequest;
 
 /// ## What it does
-/// Checks for `@singledispatchmethod` decorators on functions or static methods.
+/// Checks for `@singledispatchmethod` decorators on functions or static
+/// methods.
 ///
 /// ## Why is this bad?
-/// The `@singledispatchmethod` decorator is intended for use with class and instance methods, not functions.
+/// The `@singledispatchmethod` decorator is intended for use with class and
+/// instance methods, not functions.
 ///
 /// Instead, use the `@singledispatch` decorator.
 ///
@@ -22,7 +24,7 @@ use crate::importer::ImportRequest;
 ///
 ///
 /// @singledispatchmethod
-/// def foo(arg):
+/// def func(arg):
 ///     ...
 /// ```
 ///
@@ -32,7 +34,7 @@ use crate::importer::ImportRequest;
 ///
 ///
 /// @singledispatch
-/// def foo(arg):
+/// def func(arg):
 ///     ...
 /// ```
 ///
@@ -47,7 +49,7 @@ impl Violation for SingledispatchmethodFunction {
 
     #[derive_message_formats]
     fn message(&self) -> String {
-        format!("`@singledispatchmethod` decorator should not be used on functions")
+        format!("`@singledispatchmethod` decorator should not be used on non-method functions")
     }
 
     fn fix_title(&self) -> Option<String> {

diff --git a/...napshots/ruff_linter__rules__pylint__tests__PLE1520_singledispatchmethod_function.py.snap b/...napshots/ruff_linter__rules__pylint__tests__PLE1520_singledispatchmethod_function.py.snap
@@ -1,7 +1,7 @@
 ---
 source: crates/ruff_linter/src/rules/pylint/mod.rs
 ---
-singledispatchmethod_function.py:4:1: PLE1520 [*] `@singledispatchmethod` decorator should not be used on functions
+singledispatchmethod_function.py:4:1: PLE1520 [*] `@singledispatchmethod` decorator should not be used on non-method functions
   |
 4 | @singledispatchmethod  # [singledispatchmethod-function]
   | ^^^^^^^^^^^^^^^^^^^^^ PLE1520
@@ -21,7 +21,7 @@ singledispatchmethod_function.py:4:1: PLE1520 [*] `@singledispatchmethod` decora
 6 6 |     pass
 7 7 | 
 
-singledispatchmethod_function.py:20:5: PLE1520 [*] `@singledispatchmethod` decorator should not be used on functions
+singledispatchmethod_function.py:20:5: PLE1520 [*] `@singledispatchmethod` decorator should not be used on non-method functions
    |
 18 |         pass
 19 |