Merge branch 'main' of github.com:mkdocstrings/griffe-typingdoc

Author: pawamoy

CHANGELOG.md

@@ -6,13 +6,13 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 <!-- insertion marker -->
-## [0.2.5](https://github.com/mkdocstrings/griffe-typingdoc/releases/tag/0.2.5) - 2024-08-14
+## [0.2.5](https://github.com/mkdocstrings/griffe-typingdoc/releases/tag/0.2.5) - 2024-02-08
 
 <small>[Compare with 0.2.4](https://github.com/mkdocstrings/griffe-typingdoc/compare/0.2.4...0.2.5)</small>
 
-### Build
+### Bug Fixes
 
-- Depend on Griffe 0.49 ([b6d7bd9](https://github.com/mkdocstrings/griffe-typingdoc/commit/b6d7bd9ce462a8dbd067464b3d14a9dd25865957) by Timothée Mazzucotelli).
+- Support simple return annotations ([b4afabe](https://github.com/mkdocstrings/griffe-typingdoc/commit/b4afabed86e8b7c1905cbf672ab261be0d895e40) by Timothée Mazzucotelli). [Issue #9](https://github.com/mkdocstrings/griffe-typingdoc/issues/9)
 
 ## [0.2.4](https://github.com/mkdocstrings/griffe-typingdoc/releases/tag/0.2.4) - 2023-11-14
 

src/griffe_typingdoc/_static.py

@@ -195,6 +195,11 @@ def _returns_docs(func: Function, **kwargs: Any) -> DocstringSectionReturns | No
         "typing_extensions.Generator",
     }:
         return_annotation = annotation.slice.elements[2]  # type: ignore[attr-defined]
+    elif isinstance(annotation, ExprSubscript) and annotation.canonical_path in {
+        "typing.Annotated",
+        "typing_extensions.Annotated",
+    }:
+        return_annotation = annotation
 
     if return_annotation:
         if isinstance(return_annotation, ExprSubscript) and return_annotation.is_tuple:

tests/test_extension.py

@@ -9,6 +9,12 @@
 )
 warning_imports = "from warnings import deprecated"
 
+# NOTE: Important! The value in calls to `Doc` will be parsed as a Name expression
+# if it is valid Python syntax for names. To make sure it is correctly parsed as a string,
+# it must contain invalid syntax for names, such as a dot at the end.
+# The alternative solution would be to add `from __future__ import annotations`
+# at the beginning of each temporary visited module.
+
 
 def test_extension_on_itself() -> None:
     """Load our own package using the extension, assert a parameters section is added to the parsed docstring."""
@@ -131,3 +137,13 @@ def f() -> Generator[
         assert sections[2].value[1].description == "Second received."
         assert sections[3].value[0].description == "First returned."
         assert sections[3].value[1].description == "Second returned."
+
+
+def test_return_doc() -> None:
+    """Read documentation for return value."""
+    with temporary_visited_package(
+        "package",
+        modules={"__init__.py": f"{typing_imports}\ndef f() -> Annotated[int, Doc('Hello.')]: ..."},
+        extensions=Extensions(TypingDocExtension()),
+    ) as package:
+        assert package["f"].docstring.parsed[1].value[0].description == "Hello."