Fix return tuples (#50)

Author: flying-sheep

scanpydoc/elegant_typehints/formatting.py

@@ -93,7 +93,10 @@ def format_annotation(annotation: Type[Any], config: Config) -> Optional[str]:
 
     curframe = inspect.currentframe()
     calframe = inspect.getouterframes(curframe, 2)
-    if "process_docstring" in {calframe[2].function, calframe[3].function}:
+    if calframe[2].function == "process_docstring" or (
+        calframe[2].function == "_inject_types_to_docstring"
+        and calframe[3].function == "process_docstring"
+    ):
         return format_both(annotation, config)
     else:  # recursive use
         return _format_full(annotation, config)

scanpydoc/elegant_typehints/return_tuple.py

@@ -66,7 +66,6 @@ def process_docstring(
     # Get return section
     i_prefix = None
     l_start = None
-    l_end = None
     for l, line in enumerate(lines):
         if i_prefix is None:
             m = re_ret.match(line)

tests/test_elegant_typehints.py

@@ -305,11 +305,21 @@ class B:
     ids=["Last", "First"],
 )
 @pytest.mark.parametrize(
-    "return_ann",
-    [t.Tuple[str, int], t.Optional[t.Tuple[str, int]]],
-    ids=["Tuple", "Optional[Tuple]"],
+    "return_ann, foo_rendered",
+    [
+        (t.Tuple[str, int], ":py:class:`str`"),
+        (t.Optional[t.Tuple[str, int]], ":py:class:`str`"),
+        (
+            t.Tuple[t.Mapping[str, float], int],
+            r":annotation-terse:`:py:class:\`~typing.Mapping\``\ "
+            r":annotation-full:`:py:class:\`~typing.Mapping\`\["
+            r":py:class:\`str\`, :py:class:\`float\`"
+            r"]`",
+        ),
+    ],
+    ids=["Tuple", "Optional[Tuple]", "Complex"],
 )
-def test_return(process_doc, docstring, return_ann):
+def test_return(process_doc, docstring, return_ann, foo_rendered):
     def fn_test():
         pass
 
@@ -321,7 +331,7 @@ def fn_test():
         if not re.match("^:(rtype|param|annotation-(full|terse)):", l)
     ]
     assert lines == [
-        r":return: foo : :py:class:`str`",
+        rf":return: foo : {foo_rendered}",
         "             A foo!",
         r"         bar : :py:class:`int`",
         "             A bar!",