fix: Fix reading Google-style return section

Author: pawamoy

src/pytkdocs/parsers/docstrings/google.py

@@ -393,28 +393,29 @@ def read_return_section(self, lines: List[str], start_index: int) -> Tuple[Optio
             A tuple containing a `Section` (or `None`) and the index at which to continue parsing.
         """
         text, i = self.read_block(lines, start_index)
-        annotation = self.context["annotation"]
-        description = ""
 
-        # First try to get the annotation and description from the docstring
-        if text:
-            try:
-                type_, text = text.split(":", 1)
-            except ValueError:
-                self.error("No type in return description")
-            else:
-                annotation = type_.lstrip()
-                description = text.lstrip()
-
-        # If there was no annotation in the docstring then move to signature
-        if annotation is empty and self.context["signature"]:
-            annotation = self.context["signature"].return_annotation
-
-        # Early exit if there was no annotation in the docstring or the signature
-        if annotation is empty and not text:
+        # Early exit if there is no text in the return section
+        if not text:
             self.error(f"Empty return section at line {start_index}")
             return None, i
 
+        # First try to get the annotation and description from the docstring
+        try:
+            type_, text = text.split(":", 1)
+        except ValueError:
+            description = text
+            annotation = self.context["annotation"]
+            # If there was no annotation in the docstring then move to signature
+            if annotation is empty and self.context["signature"]:
+                annotation = self.context["signature"].return_annotation
+        else:
+            annotation = type_.lstrip()
+            description = text.lstrip()
+
+        # There was no type in the docstring and no annotation
+        if annotation is empty:
+            self.error("No return type/annotation in docstring/signature")
+
         return Section(Section.Type.RETURN, AnnotatedObject(annotation, description)), i
 
     def read_examples_section(self, lines: List[str], start_index: int) -> Tuple[Optional[Section], int]:

tests/test_parsers/test_docstrings/test_google.py

@@ -76,7 +76,7 @@ def test_property_docstring():
     prop = class_.attributes[0]
     sections, errors = prop.docstring_sections, prop.docstring_errors
     assert len(sections) == 2
-    assert len(errors) == 1
+    assert not errors
 
 
 def test_function_without_annotations():
@@ -101,7 +101,7 @@ def f(x, y, *, z):
     sections, errors = parse(inspect.getdoc(f), inspect.signature(f))
     assert len(sections) == 4
     assert len(errors) == 1
-    assert "No type in return" in errors[0]
+    assert "No return type/annotation in" in errors[0]
 
 
 def test_function_with_annotations():
@@ -125,7 +125,7 @@ def f(x: int, y: int, *, z: int) -> int:
 
     sections, errors = parse(inspect.getdoc(f), inspect.signature(f))
     assert len(sections) == 4
-    assert len(errors) == 1
+    assert not errors
 
 
 def test_function_with_examples():

tests/test_parsers/test_docstrings/test_numpy.py

@@ -14,7 +14,8 @@ class DummyObject:
 def parse(docstring, signature=None, return_type=inspect.Signature.empty):
     """Helper to parse a doctring."""
     return Numpy().parse(
-        dedent(docstring).strip(), {"obj": DummyObject(), "signature": signature, "type": return_type},
+        dedent(docstring).strip(),
+        {"obj": DummyObject(), "signature": signature, "type": return_type},
     )
 
 
@@ -79,7 +80,7 @@ def test_property_docstring():
     prop = class_.attributes[0]
     sections, errors = prop.docstring_sections, prop.docstring_errors
     assert len(sections) == 2
-    assert len(errors) == 1
+    assert not errors
 
 
 def test_function_without_annotations():