Fix bug in isShortDocstring (#256)

Author: jsh9

.pre-commit-config.yaml

@@ -5,7 +5,7 @@ repos:
       - id: isort
 
   - repo: https://github.com/jsh9/muff-pre-commit
-    rev: 0.12.9
+    rev: 0.12.11.1
     hooks:
       - id: muff-format
         args: [--config, muff.toml]

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Change Log
 
+## [0.6.11] - 2025-08-31
+
+- Fixed
+  - A bug where short docstring is incorrectly detected
+- Full diff
+  - https://github.com/jsh9/pydoclint/compare/0.6.10...0.6.11
+
 ## [0.6.10] - 2025-08-14
 
 - Changed

README.md

@@ -60,7 +60,6 @@ The corresponding Github repository of _pydoclint_ is:
 - [3. Style violation codes](#3-style-violation-codes)
 - [4. Additional notes for users](#4-additional-notes-for-users)
 - [5. Notes for developers](#5-notes-for-developers)
-- [6. Miscellaneous notes](#6-miscellaneous-notes)
 
 <!--TOC-->
 
@@ -214,6 +213,14 @@ For detailed explanations of each violation code, please read this page:
 
 ## 4. Additional notes for users
 
+Here are some additional notes to help you use _pydoclint_ more easily:
+
+- [Notes for users](https://jsh9.github.io/pydoclint/notes_for_users.html)
+  - (Contains frequently encountered issues)
+- [Checking class attributes](https://jsh9.github.io/pydoclint/checking_class_attributes.html)
+- [Notes on `Generator` vs `Iterator`](https://jsh9.github.io/pydoclint/notes_generator_vs_iterator.html)
+- [More about docstring style mismatch (`DOC003`)](https://jsh9.github.io/pydoclint/style_mismatch.html)
+
 If you'd like to use _pydoclint_ for your project, it is recommended that you
 read these additional notes
 [here](https://jsh9.github.io/pydoclint/notes_for_users.html).
@@ -227,9 +234,3 @@ If you'd like to contribute to the code base of _pydoclint_, thank you!
 
 [This guide](https://jsh9.github.io/pydoclint/notes_for_developers.html) can
 hopefully help you get familiar with the code base faster.
-
-## 6. Miscellaneous notes
-
-- [Checking class attributes](https://jsh9.github.io/pydoclint/checking_class_attributes.html)
-- [Notes on `Generator` vs `Iterator`](https://jsh9.github.io/pydoclint/notes_generator_vs_iterator.html)
-- [More about docstring style mismatch (`DOC003`)](https://jsh9.github.io/pydoclint/style_mismatch.html)

docs/index.md

@@ -60,7 +60,6 @@ The corresponding Github repository of _pydoclint_ is:
 - [3. Style violation codes](#3-style-violation-codes)
 - [4. Additional notes for users](#4-additional-notes-for-users)
 - [5. Notes for developers](#5-notes-for-developers)
-- [6. Miscellaneous notes](#6-miscellaneous-notes)
 
 <!--TOC-->
 
@@ -214,6 +213,14 @@ For detailed explanations of each violation code, please read this page:
 
 ## 4. Additional notes for users
 
+Here are some additional notes to help you use _pydoclint_ more easily:
+
+- [Notes for users](https://jsh9.github.io/pydoclint/notes_for_users.html)
+  - (Contains frequently encountered issues)
+- [Checking class attributes](https://jsh9.github.io/pydoclint/checking_class_attributes.html)
+- [Notes on `Generator` vs `Iterator`](https://jsh9.github.io/pydoclint/notes_generator_vs_iterator.html)
+- [More about docstring style mismatch (`DOC003`)](https://jsh9.github.io/pydoclint/style_mismatch.html)
+
 If you'd like to use _pydoclint_ for your project, it is recommended that you
 read these additional notes
 [here](https://jsh9.github.io/pydoclint/notes_for_users.html).
@@ -227,9 +234,3 @@ If you'd like to contribute to the code base of _pydoclint_, thank you!
 
 [This guide](https://jsh9.github.io/pydoclint/notes_for_developers.html) can
 hopefully help you get familiar with the code base faster.
-
-## 6. Miscellaneous notes
-
-- [Checking class attributes](https://jsh9.github.io/pydoclint/checking_class_attributes.html)
-- [Notes on `Generator` vs `Iterator`](https://jsh9.github.io/pydoclint/notes_generator_vs_iterator.html)
-- [More about docstring style mismatch (`DOC003`)](https://jsh9.github.io/pydoclint/style_mismatch.html)

pydoclint/utils/doc.py

@@ -58,6 +58,8 @@ def isShortDocstring(self) -> bool:  # type:ignore[return]
                 and len(self.parsed.raises) == 0
                 and self.parsed.returns is None
                 and len(self.parsed.many_returns) == 0
+                and self.parsed.yields is None
+                and len(self.parsed.many_yields) == 0
                 and len(self.parsed.examples) == 0
                 and self.parsed.deprecation is None
             )

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pydoclint"
-version = "0.6.10"
+version = "0.6.11"
 description = "A Python docstring linter that checks arguments, returns, yields, and raises sections"
 readme = "README.md"
 license = {text = "MIT"}

requirements.dev

@@ -0,0 +1,3 @@
+tox
+pytest
+pre-commit

tests/data/edge_cases/29_yields_section/case.py

@@ -0,0 +1,12 @@
+# From https://github.com/jsh9/pydoclint/issues/254
+
+def test_yield_with_typing_no_args() -> Generator[typing.Any]:
+    """
+    Testing the behaviour of pydoclint with a function which has specified the Generator via
+    the typing module and has no arguments
+
+    Yields:
+        Generator123[typing.Any]: An iterable argument
+
+    """
+    yield [1]

tests/test_main.py

@@ -1942,6 +1942,19 @@ def testNonAscii() -> None:
                 '"google" style, but the docstring is likely not written in this style.',
             ],
         ),
+        (
+            '29_yields_section/case.py',
+            {
+                'style': 'google',
+                'skipCheckingShortDocstrings': True,
+            },
+            [
+                'DOC404: Function `test_yield_with_typing_no_args` yield type(s) in docstring '
+                'not consistent with the return annotation. The yield type (the 0th arg in '
+                'Generator[...]/Iterator[...]): Generator[typing.Any]; docstring "yields" '
+                'section types: Generator123[typing.Any]'
+            ],
+        ),
     ],
 )
 def testEdgeCases(