Lint

Author: domdfcoding

flake8_sphinx_links/__init__.py

@@ -190,6 +190,8 @@ def __init__(self) -> None:
 	def _check_docstring(self, node: Union[ast.ClassDef, ast.FunctionDef, ast.Module]) -> None:
 		"""
 		Check the docstring of a function, or a method of a class.
+
+		:param node:
 		"""
 
 		docstring = ast.get_docstring(node, clean=False)
@@ -208,7 +210,7 @@ def _check_docstring(self, node: Union[ast.ClassDef, ast.FunctionDef, ast.Module
 			if (
 					sys.version_info < (3, 8) and platform.python_implementation() != "PyPy"
 					):  # pragma: no cover (PY38+ or PyPy)
-				doc_end_lineno = node.body[0].value.lineno  # type: ignore
+				doc_end_lineno = node.body[0].value.lineno
 
 				# Calculate the start line
 				doc_start_lineno = doc_end_lineno - doc_line_length
@@ -221,7 +223,7 @@ def _check_docstring(self, node: Union[ast.ClassDef, ast.FunctionDef, ast.Module
 				doc_start_lineno += 1
 
 			else:  # pragma: no cover (<PY38 and !PyPy)
-				doc_start_lineno = node.body[0].value.lineno  # type: ignore
+				doc_start_lineno = node.body[0].value.lineno  # type: ignore[attr-defined]
 
 			for offset, line in enumerate(docstring.splitlines()):
 

tests/flake8_sphinx_links_test.py

@@ -1,6 +1,6 @@
 # stdlib
 import ast
-from typing import Set
+from typing import Any, Set
 
 # 3rd party
 import pytest
@@ -14,7 +14,7 @@ def results(s: str) -> Set[str]:
 
 
 @pytest.mark.parametrize("obj", py_obj)
-def test_bad_docstring_py_obj(obj):
+def test_bad_docstring_py_obj(obj: Any):
 	test_code = f'''"""
 
 ``{obj}``
@@ -41,12 +41,8 @@ def good_docstring():
 
 '''
 
-	assert results(test_code
-					) == {  # noqa: sphinx_links001
-							f"3:0: {SXL001}",
-							f"8:0: {SXL001}",
-							f"13:1: {SXL001}",
-							}
+	expected_results = {f"3:0: {SXL001}", f"8:0: {SXL001}", f"13:1: {SXL001}"}
+	assert results(test_code) == expected_results
 
 
 @pytest.mark.parametrize("obj", py_obj_python)
@@ -77,16 +73,12 @@ class good_docstring():
 
 '''
 
-	assert results(test_code
-					) == {  # noqa: sphinx_links001
-							f"3:0: {SXL001}",
-							f"8:0: {SXL001}",
-							f"13:1: {SXL001}",
-							}
+	expected_results = {f"3:0: {SXL001}", f"8:0: {SXL001}", f"13:1: {SXL001}"}
+	assert results(test_code) == expected_results
 
 
 @pytest.mark.parametrize("obj", exc)
-def test_bad_docstring_exc(obj):
+def test_bad_docstring_exc(obj: Any):
 	test_code = f'''"""
 
 ``{obj}``
@@ -111,12 +103,8 @@ class good_docstring():
 
 '''
 
-	assert results(test_code
-					) == {  # noqa: sphinx_links001
-							f"3:0: {SXL001}",
-							f"8:0: {SXL001}",
-							f"12:0: {SXL001}",
-							}
+	expected_results = {f"3:0: {SXL001}", f"8:0: {SXL001}", f"12:0: {SXL001}"}
+	assert results(test_code) == expected_results
 
 
 @pytest.mark.parametrize("obj", class_)
@@ -145,9 +133,5 @@ class good_docstring():
 
 '''
 
-	assert results(test_code
-					) == {  # noqa: sphinx_links001
-							f"3:0: {SXL001}",
-							f"8:0: {SXL001}",
-							f"13:1: {SXL001}",
-							}
+	expected_results = {f"3:0: {SXL001}", f"8:0: {SXL001}", f"13:1: {SXL001}"}
+	assert results(test_code) == expected_results