lint fixes

Author: analog-cbarber

src/mkdocstrings_handlers/python_xref/crossref.py

@@ -318,28 +318,32 @@ def _error(self, msg: str, just_warn: bool = False) -> None:
         self._ok = just_warn
 
 
-def substitute_relative_crossrefs(obj: Object, checkref: Optional[Callable[[str], bool]] = None) -> None:
+def substitute_relative_crossrefs(
+    obj: Alias|Object,
+    checkref: Optional[Callable[[str], bool]] = None,
+) -> None:
     """Recursively expand relative cross-references in all docstrings in tree.
 
     Arguments:
         obj: a Griffe [Object][griffe.] whose docstrings should be modified
         checkref: optional function to check whether computed cross-reference is valid.
             Should return True if valid, False if not valid.
     """
+    if isinstance(obj, Alias):
+        try:
+            obj = obj.target
+        except GriffeError:
+            # If alias could not be resolved, it probably refers
+            # to an external package, not be documented.
+            return
+
     doc = obj.docstring
 
     if doc is not None:
         doc.value = _RE_CROSSREF.sub(_RelativeCrossrefProcessor(doc, checkref=checkref), doc.value)
 
     for member in obj.members.values():
-        if isinstance(member, Alias):
-            try:
-                member = member.target
-            except GriffeError as ex:
-                # If alias could not be resolved, it probably refers
-                # to an external package, not be documented.
-                pass
-        if isinstance(member, Object):  # pragma: no branch
+        if isinstance(member, (Alias,Object)):  # pragma: no branch
             substitute_relative_crossrefs(member, checkref=checkref)
 
 def doc_value_offset_to_location(doc: Docstring, offset: int) -> tuple[int,int]:

tests/project/src/myproj/pkg/dataclass.py

@@ -1,3 +1,6 @@
+"""
+Dataclass example
+"""
 
 from dataclasses import dataclass, field
 
@@ -18,5 +21,5 @@ class Dataclass:
     example: [`content`][(c).]
     """
 
-    def method(self) -> str:
+    def method(self) -> None:
         """Example method."""

tests/test_crossref.py

@@ -267,11 +267,16 @@ def test_doc_value_offset_to_location() -> None:
     assert doc_value_offset_to_location(doc3, 6) == (3, 3)
 
 def test_griffe() -> None:
+    """
+    Test substitution on griffe rep of local project
+    Returns:
+
+    """
     this_dir = Path(__file__).parent
     test_src_dir  = this_dir / "project" / "src"
     myproj = griffe.load(
         "myproj",
         search_paths = [ test_src_dir ],
     )
     substitute_relative_crossrefs(myproj)
-    print(myproj)
+    # TODO - grovel output