Fix bug in type hint checking (#29)

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change Log
 
+## [0.0.10] - 2023-06-12
+
+- Fixed
+  - Fixed a bug in checking type hints when the function signature only
+    contains star arguments
+- Full diff
+  - https://github.com/jsh9/pydoclint/compare/0.0.9...0.0.10
+
 ## [0.0.9] - 2023-06-12
 
 - Changed

pydoclint/utils/arg.py

@@ -223,19 +223,14 @@ def noTypeHints(self) -> bool:
         return not self.hasTypeHintInAnyArg()
 
     def hasTypeHintInAnyArg(self) -> bool:
-        """
-        Check whether any arg has a type hint.
-
-        Start arguments (such as `*args` or `**kwargs`) are excluded because
-        they don't need to have type hints.
-        """
-        return any(_.hasTypeHint() for _ in self.infoList if _.notStarArg())
+        """Check whether any arg has a type hint"""
+        return any(_.hasTypeHint() for _ in self.infoList)
 
     def hasTypeHintInAllArgs(self) -> bool:
         """
         Check whether all args have a type hint.
 
-        Start arguments (such as `*args` or `**kwargs`) are excluded because
+        Star arguments (such as `*args` or `**kwargs`) are excluded because
         they don't need to have type hints.
         """
         return all(_.hasTypeHint() for _ in self.infoList if _.notStarArg())

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = pydoclint
-version = 0.0.9
+version = 0.0.10
 description = A Python docstring linter that checks arguments, returns, yields, and raises sections
 long_description = file: README.md
 long_description_content_type = text/markdown

tests/data/google/star_args/cases2.py

@@ -0,0 +1,13 @@
+from typing import Dict, Tuple
+
+
+class A:
+    def __init__(self, *args: Tuple, **kwargs: Dict) -> None:
+        """
+        Do something.
+
+        Args:
+            *args: Args
+            **kwargs: Keyword args
+        """
+        pass

tests/data/numpy/star_args/cases2.py

@@ -0,0 +1,16 @@
+from typing import Dict, Tuple
+
+
+class A:
+    def __init__(self, *args: Tuple, **kwargs: Dict) -> None:
+        """
+        Do something.
+
+        Parameters
+        ----------
+        *args :
+            Args
+        **kwargs :
+            Keyword args
+        """
+        pass

tests/test_main.py

@@ -428,6 +428,19 @@ def testStarsInArgumentList(style: str) -> None:
     assert list(map(str, violations)) == expected
 
 
+@pytest.mark.parametrize('style', ['numpy', 'google'])
+def testStarsInArgumentList2(style: str) -> None:
+    violations = _checkFile(
+        filename=DATA_DIR / f'{style}/star_args/cases2.py',
+        typeHintsInSignature=True,
+        typeHintsInDocstring=False,
+        allowInitDocstring=True,
+        style=style,
+    )
+    expected = []
+    assert list(map(str, violations)) == expected
+
+
 def testParsingErrors_google() -> None:
     violations = _checkFile(
         filename=DATA_DIR / 'google/parsing_errors/cases.py',