misc: support lone :rtype: meta

Author: rr-

docstring_parser/epydoc.py

@@ -156,7 +156,7 @@ def parse(text: str) -> Docstring:
 
             meta_item = DocstringParam(
                 args=[key, arg_name],
-                description=info["description"],
+                description=info.get("description"),
                 arg_name=arg_name,
                 type_name=type_name,
                 is_optional=is_optional,
@@ -167,7 +167,7 @@ def parse(text: str) -> Docstring:
             info = params["return"]
             meta_item = DocstringReturns(
                 args=[key],
-                description=info["description"],
+                description=info.get("description"),
                 type_name=info.get("type_name"),
                 is_generator=info.get("is_generator", False),
             )
@@ -256,8 +256,9 @@ def process_desc(desc: T.Optional[str], is_type: bool) -> str:
             if meta.type_name:
                 text = f"@{type_key}:" + process_desc(meta.type_name, True)
                 parts.append(text)
-            text = f"@{arg_key}:" + process_desc(meta.description, False)
-            parts.append(text)
+            if meta.description:
+                text = f"@{arg_key}:" + process_desc(meta.description, False)
+                parts.append(text)
         elif isinstance(meta, DocstringRaises):
             text = f"@raise {meta.type_name}:" if meta.type_name else "@raise:"
             text += process_desc(meta.description, False)

docstring_parser/rest.py

@@ -160,6 +160,18 @@ def parse(text: str) -> Docstring:
         elif isinstance(meta, DocstringReturns):
             meta.type_name = meta.type_name or rtypes.get(meta.return_name)
 
+    if not any(isinstance(m, DocstringReturns) for m in ret.meta) and rtypes:
+        for (return_name, type_name) in rtypes.items():
+            ret.meta.append(
+                DocstringReturns(
+                    args=[],
+                    type_name=type_name,
+                    description=None,
+                    is_generator=False,
+                    return_name=return_name,
+                )
+            )
+
     return ret
 
 
@@ -227,9 +239,10 @@ def process_desc(desc: T.Optional[str]) -> str:
             key = "yields" if meta.is_generator else "returns"
 
             if rendering_style == RenderingStyle.EXPANDED:
-                text = f":{key}:"
-                text += process_desc(meta.description)
-                parts.append(text)
+                if meta.description:
+                    text = f":{key}:"
+                    text += process_desc(meta.description)
+                    parts.append(text)
                 if type_text:
                     parts.append(f":rtype:{type_text}")
             else:

docstring_parser/tests/test_epydoc.py

@@ -714,3 +714,10 @@ def test_compose_expanded(source: str, expected: str) -> None:
         compose(parse(source), rendering_style=RenderingStyle.EXPANDED)
         == expected
     )
+
+
+def test_short_rtype() -> None:
+    """Test abbreviated docstring with only return type information."""
+    string = "Short description.\n\n@rtype: float"
+    docstring = parse(string)
+    assert compose(docstring) == string

docstring_parser/tests/test_google.py

@@ -329,7 +329,7 @@ def test_meta_with_multiline_description() -> None:
     assert docstring.meta[0].description == "asd\n1\n    2\n3"
 
 
-def test_default_args():
+def test_default_args() -> None:
     """Test parsing default arguments."""
     docstring = parse(
         """A sample function

docstring_parser/tests/test_numpydoc.py

@@ -225,7 +225,7 @@ def test_meta_with_multiline_description() -> None:
     assert docstring.meta[0].description == "asd\n1\n    2\n3"
 
 
-def test_default_args():
+def test_default_args() -> None:
     """Test parsing default arguments."""
     docstring = parse(
         """

docstring_parser/tests/test_rest.py

@@ -521,3 +521,11 @@ def test_compose(rendering_style: RenderingStyle, expected: str) -> None:
         """
     )
     assert compose(docstring, rendering_style=rendering_style) == expected
+
+
+def test_short_rtype() -> None:
+    """Test abbreviated docstring with only return type information."""
+    string = "Short description.\n\n:rtype: float"
+    docstring = parse(string)
+    rendering_style = RenderingStyle.EXPANDED
+    assert compose(docstring, rendering_style=rendering_style) == string