clarify message

astral-sh · Jul 26, 2024 · 16e30f2 · 16e30f2
1 parent 97ef2bc
commit 16e30f2
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 5 deletions.
diff --git a/crates/ruff_linter/src/rules/pydoclint/rules/check_docstring.rs b/crates/ruff_linter/src/rules/pydoclint/rules/check_docstring.rs
@@ -98,7 +98,7 @@ pub struct DocstringExtraneousReturns;
 impl Violation for DocstringExtraneousReturns {
     #[derive_message_formats]
     fn message(&self) -> String {
-        format!("Docstring should not have a returns section")
+        format!("Docstring should not have a returns section because the function doesn't return anything")
     }
 }
 

diff --git a/.../ruff_linter__rules__pydoclint__tests__docstring-extraneous-returns_DOC202_google.py.snap b/.../ruff_linter__rules__pydoclint__tests__docstring-extraneous-returns_DOC202_google.py.snap
@@ -1,7 +1,7 @@
 ---
 source: crates/ruff_linter/src/rules/pydoclint/mod.rs
 ---
-DOC202_google.py:20:1: DOC202 Docstring should not have a returns section
+DOC202_google.py:20:1: DOC202 Docstring should not have a returns section because the function doesn't return anything
    |
 18 |           num (int): A number
 19 |   
@@ -12,7 +12,7 @@ DOC202_google.py:20:1: DOC202 Docstring should not have a returns section
 23 |       print('test')
    |
 
-DOC202_google.py:36:1: DOC202 Docstring should not have a returns section
+DOC202_google.py:36:1: DOC202 Docstring should not have a returns section because the function doesn't return anything
    |
 34 |               num (int): A number
 35 |   

diff --git a/...s/ruff_linter__rules__pydoclint__tests__docstring-extraneous-returns_DOC202_numpy.py.snap b/...s/ruff_linter__rules__pydoclint__tests__docstring-extraneous-returns_DOC202_numpy.py.snap
@@ -1,7 +1,7 @@
 ---
 source: crates/ruff_linter/src/rules/pydoclint/mod.rs
 ---
-DOC202_numpy.py:24:1: DOC202 Docstring should not have a returns section
+DOC202_numpy.py:24:1: DOC202 Docstring should not have a returns section because the function doesn't return anything
    |
 22 |           A number
 23 |   
@@ -14,7 +14,7 @@ DOC202_numpy.py:24:1: DOC202 Docstring should not have a returns section
 29 |       print('test')
    |
 
-DOC202_numpy.py:44:1: DOC202 Docstring should not have a returns section
+DOC202_numpy.py:44:1: DOC202 Docstring should not have a returns section because the function doesn't return anything
    |
 42 |               A number
 43 |