docs: Add example with a simple return value

mkdocstrings · Feb 7, 2024 · edef990 · edef990
1 parent 3aa11a2
commit edef990
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/docs/examples/simple.py b/docs/examples/simple.py
@@ -40,6 +40,12 @@ def other_parameters(
     """Showing off other parameters."""
 
 
+# Documenting returned values, replacing Returns sections:
+def return_value() -> Annotated[int, Doc("Returned integer.")]:
+    """Showing off return values."""
+    return 0
+
+
 # Documenting yielded and received values, replacing Yields and Receives sections:
 def generator() -> Generator[
     Annotated[int, Doc("Yielded integers.")],