ci: Quality

Author: pawamoy

src/griffe_typingdoc/extension.py

@@ -37,7 +37,7 @@ def visit_functiondef(
         This function takes a function definition node and visits its contents,
         particularly its decorators, to build up the documentation metadata.
         """
-        function: Function = self.visitor.current.members[node.name]  # type: ignore[assignment]
+        func: Function = self.visitor.current.members[node.name]  # type: ignore[assignment]
 
         func_doc = {}
         for decorator_node in node.decorator_list:
@@ -46,20 +46,18 @@ def visit_functiondef(
 
         params_doc: dict[str, dict[str, Any]] = defaultdict(dict)
         for arg in node.args.args:
-            if isinstance(arg.annotation, ast.Subscript):
-                if arg.annotation.value.id == "Annotated":  # type: ignore[attr-defined]
-                    param_name = arg.arg
-                    params_doc[param_name]["annotation"] = safe_get_annotation(
-                        arg.annotation.slice.elts[0],  # type: ignore[attr-defined]
-                        function.parent,  # type: ignore[arg-type]
-                    )
-                    doc = arg.annotation.slice.elts[1]  # type: ignore[attr-defined]
-                    if isinstance(doc, ast.Call):
-                        if doc.func.id == "__typing_doc__":  # type: ignore[attr-defined]
-                            params_doc[param_name].update({kw.arg: kw.value.value for kw in doc.keywords})  # type: ignore[attr-defined,misc]
+            if isinstance(arg.annotation, ast.Subscript) and arg.annotation.value.id == "Annotated":  # type: ignore[attr-defined]
+                param_name = arg.arg
+                params_doc[param_name]["annotation"] = safe_get_annotation(
+                    arg.annotation.slice.elts[0],  # type: ignore[attr-defined]
+                    func.parent,
+                )
+                doc = arg.annotation.slice.elts[1]  # type: ignore[attr-defined]
+                if isinstance(doc, ast.Call) and doc.func.id == "__typing_doc__":  # type: ignore[attr-defined]
+                    params_doc[param_name].update({kw.arg: kw.value.value for kw in doc.keywords})  # type: ignore[attr-defined,misc]
 
-        if (func_doc or params_doc) and function.docstring:
-            sections = function.docstring.parsed
+        if (func_doc or params_doc) and func.docstring:
+            sections = func.docstring.parsed
             if params_doc:
                 docstring_params = []
                 for param_name, param_doc in params_doc.items():
@@ -68,7 +66,7 @@ def visit_functiondef(
                             name=param_name,
                             description=param_doc["description"],
                             annotation=param_doc["annotation"],
-                            value=function.parameters[param_name].default,
+                            value=func.parameters[param_name].default,  # type: ignore[arg-type]
                         ),
                     )
                 sections.append(DocstringSectionParameters(docstring_params))

src/griffe_typingdoc/typing_doc.py

@@ -12,10 +12,10 @@
 
 def __typing_doc__(  # noqa: N807
     *,
-    description: str | None = None,
-    deprecated: bool = False,
-    discouraged: bool = False,
-    raises: Mapping[type[BaseException], str | None] | None = None,
-    extra: dict[Any, Any] | None = None,
+    description: str | None = None,  # noqa: ARG001
+    deprecated: bool = False,  # noqa: ARG001
+    discouraged: bool = False,  # noqa: ARG001
+    raises: Mapping[type[BaseException], str | None] | None = None,  # noqa: ARG001
+    extra: dict[Any, Any] | None = None,  # noqa: ARG001
 ) -> Callable[[_Type], _Type]:
     return lambda _: _

tests/test_extension.py

@@ -7,7 +7,7 @@
 from griffe_typingdoc.extension import TypingDocExtension
 
 
-def test_extension():
+def test_extension() -> None:
     """Load our own package using the extension, assert a parameters section is added to the parsed docstring."""
     loader = GriffeLoader(extensions=Extensions(TypingDocExtension()))
     typingdoc = loader.load_module("griffe_typingdoc")