Fix typo in flake8 config; fix LN001/002 violations (#226)

Author: jsh9

CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-## [unpublished]
+## [0.6.3] - 2025-03-30
 
 - Added
   - Added `DOC504` and a config option
@@ -9,6 +9,11 @@
     declaration is required in the docstring. Otherwise `DOC504` is raised.
     (This changes the behavior introduced in v0.6.1.)
   - Added a new config option `--ignore-private-args` (default to `False`)
+- Changed
+  - Canceled the ignoring of `LN002` violation in flake8 config in tox
+  - Fix a typo in maximum line length setting in flake8 config in tox
+- Full diff
+  - https://github.com/jsh9/pydoclint/compare/0.6.2...0.6.3
 
 ## [0.6.2] - 2025-02-17
 

pydoclint/utils/arg.py

@@ -120,12 +120,12 @@ def _typeHintsEq(cls, hint1: str, hint2: str) -> bool:
         # >>>     "ghi",
         # >>> ]
         try:
-            hint1_: str = unparseName(ast.parse(stripQuotes(hint1)))  # type:ignore[arg-type,assignment]
+            hint1_: str = unparseName(ast.parse(stripQuotes(hint1)))  # type:ignore[arg-type,assignment]  # noqa: LN002
         except SyntaxError:
             hint1_ = hint1
 
         try:
-            hint2_: str = unparseName(ast.parse(stripQuotes(hint2)))  # type:ignore[arg-type,assignment]
+            hint2_: str = unparseName(ast.parse(stripQuotes(hint2)))  # type:ignore[arg-type,assignment]  # noqa: LN002
         except SyntaxError:
             hint2_ = hint2
 
@@ -263,7 +263,7 @@ def _unparseTargetAndAppendToInfoList(
             msg2: str = (
                 f' astAssign.targets[{i}] is of type {type(target)}.'
                 if j is None
-                else f' astAssign.targets[{i}].elts[{j}] is of type {type(target)}.'
+                else f' astAssign.targets[{i}].elts[{j}] is of type {type(target)}.'  # noqa: LN001
             )
             msg: str = msg1 + msg2
             raise EdgeCaseError(msg) from ex

pydoclint/utils/invisibleChars.py

@@ -1,7 +1,7 @@
 def replaceInvisibleChars(text: str) -> str:
     """Replace invisible characters so that AST can correctly parse the code"""
     invisibleToSpace = {
-        '\uFEFF': ' ',  # Byte order mark (zero-width but might act as a separator)
+        '\uFEFF': ' ',  # Byte order mark: 0-width but might act as a separator
     }
 
     invisibleToEmpty = {

pydoclint/utils/return_anno.py

@@ -57,11 +57,11 @@ def decompose(self) -> list[str]:
                 # because we don't know the tuple's length
                 return [self.annotation]
 
-            parsedBody0: ast.Expr = ast.parse(insideTuple).body[0]  # type:ignore[assignment]
-            if isinstance(parsedBody0.value, ast.Name):  # like this: Tuple[int]
+            parsedBody0: ast.Expr = ast.parse(insideTuple).body[0]  # type:ignore[assignment]  # noqa: LN002
+            if isinstance(parsedBody0.value, ast.Name):  # like this: Tuple[int]  # noqa: LN002
                 return [insideTuple]
 
-            if isinstance(parsedBody0.value, ast.Tuple):  # like Tuple[int, str]
+            if isinstance(parsedBody0.value, ast.Tuple):  # like Tuple[int, str]  # noqa: LN002
                 elts: list[ast.expr] = parsedBody0.value.elts
                 return [unparseName(_) for _ in elts]  # type:ignore[misc]
 
@@ -72,7 +72,7 @@ def decompose(self) -> list[str]:
     def _isTuple(self) -> bool:
         try:
             assert self.annotation is not None  # to help mypy understand type
-            annoHead = ast.parse(self.annotation).body[0].value.value.id  # type:ignore[attr-defined]
+            annoHead = ast.parse(self.annotation).body[0].value.value.id  # type:ignore[attr-defined]  # noqa: LN002
             return annoHead in {'tuple', 'Tuple'}
         except Exception:
             return False

pydoclint/utils/return_yield_raise.py

@@ -163,14 +163,14 @@ def _getRaisedExceptions(  # noqa: C901
                     if isinstance(child.exc, ast.Attribute):
                         # case: looks like m.n.exception
                         exceptionName = unparseName(child.exc)
-                        assert isinstance(exceptionName, str)  # make mypy happy
+                        assert isinstance(exceptionName, str)  # satisfy mypy
                         yield exceptionName
                     elif isinstance(child.exc, ast.Call) and isinstance(
                         child.exc.func, ast.Attribute
                     ):
                         # case: looks like m.n.exception()
                         exceptionName = unparseName(child.exc.func)
-                        assert isinstance(exceptionName, str)  # make mypy happy
+                        assert isinstance(exceptionName, str)  # satisfy mypy
                         yield exceptionName
                     elif (
                         currentParentExceptHandler
@@ -180,7 +180,8 @@ def _getRaisedExceptions(  # noqa: C901
                         # case: "except <> as e; raise e" -> we must yield the
                         # stuff in <>
                         #
-                        # Note: if subnode.id != currentParentExceptHandler.name,
+                        # Note:
+                        # if subnode.id != currentParentExceptHandler.name,
                         # the user is raising something not bound by
                         # this exception handler (meaning we should fall
                         # through to yielding the subnode.id)

pydoclint/utils/visitor_helper.py

@@ -517,7 +517,7 @@ def extractYieldTypeFromGeneratorOrIteratorAnnotation(
                 )
             else:
                 yieldType = unparseName(
-                    ast.parse(returnAnnoText).body[0].value.slice.elts[0]  # type:ignore[attr-defined,arg-type]
+                    ast.parse(returnAnnoText).body[0].value.slice.elts[0]  # type:ignore[attr-defined,arg-type]  # noqa: LN002
                 )
         elif hasIteratorOrIterableAsReturnAnnotation:
             yieldType = unparseName(
@@ -542,7 +542,7 @@ def extractReturnTypeFromGenerator(returnAnnoText: str | None) -> str | None:
     try:
         if sys.version_info >= (3, 9):
             returnType = unparseName(
-                ast.parse(returnAnnoText).body[0].value.slice.elts[-1]  # type:ignore[attr-defined,arg-type]
+                ast.parse(returnAnnoText).body[0].value.slice.elts[-1]  # type:ignore[attr-defined,arg-type]  # noqa: LN002
             )
         else:
             returnType = unparseName(

pydoclint/visitor.py

@@ -312,7 +312,7 @@ def _checkClassDocstringAndConstructorDocstrings(  # noqa: C901
 
         classDocstring: str = getDocstring(parent_)
 
-        if len(initDocstring) == 0:  # __init__() doesn't have its own docstring
+        if len(initDocstring) == 0:  # __init__() doesn't have own docstring
             # Check class docstring instead, because that's what we care
             # about when checking the class constructor.
             return classDocstring
@@ -831,8 +831,8 @@ def my_function(num: int) -> Generator[int, None, str]:
                         returnAnnoText=returnAnno.annotation,
                     )
                     # If "Generator[...]" is put in the return type annotation,
-                    # we don't need a "Returns" section in the docstring. Instead,
-                    # we need a "Yields" section.
+                    # we don't need a "Returns" section in the docstring.
+                    # Instead, we need a "Yields" section.
                     if self.requireReturnSectionWhenReturningNothing:
                         violations.append(v201)
                     elif retTypeInGenerator not in {'None', 'NoReturn'}:
@@ -870,15 +870,15 @@ def my_function(num: int) -> Generator[int, None, str]:
                     yieldType: str | None = extract(
                         returnAnnoText=returnAnno.annotation,
                         hasGeneratorAsReturnAnnotation=hasGenAsRetAnno,
-                        hasIteratorOrIterableAsReturnAnnotation=hasIterAsRetAnno,
+                        hasIteratorOrIterableAsReturnAnnotation=hasIterAsRetAnno,  # noqa: LN001
                     )
                     checkYieldTypesForViolations(
                         returnAnnotation=ReturnAnnotation(yieldType),
                         violationList=violations,
                         yieldSection=yieldSec,
                         violation=v404,
                         hasGeneratorAsReturnAnnotation=hasGenAsRetAnno,
-                        hasIteratorOrIterableAsReturnAnnotation=hasIterAsRetAnno,
+                        hasIteratorOrIterableAsReturnAnnotation=hasIterAsRetAnno,  # noqa: LN001
                         requireYieldSectionWhenYieldingNothing=(
                             self.requireYieldSectionWhenYieldingNothing
                         ),

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = pydoclint
-version = 0.6.2
+version = 0.6.3
 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/utils/test_returns_yields_raise.py

@@ -428,7 +428,7 @@ def func9(d):
             raise
 
 def func10():
-    # no variable resolution is done. this function looks like it throws GError.
+    # no variable resolution is done. this func looks like it throws GError.
     GError = ZeroDivisionError
     try:
         1 / 0

tox.ini

@@ -98,7 +98,7 @@ commands =
 
 
 [flake8]
-max-line-length = 88
+max-line-length = 79
 extend-ignore =
     # E501: line length
     E501,