Skip to content

Commit edef990

Browse files
committed
docs: Add example with a simple return value
1 parent 3aa11a2 commit edef990

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

docs/examples/simple.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,12 @@ def other_parameters(
4040
"""Showing off other parameters."""
4141

4242

43+
# Documenting returned values, replacing Returns sections:
44+
def return_value() -> Annotated[int, Doc("Returned integer.")]:
45+
"""Showing off return values."""
46+
return 0
47+
48+
4349
# Documenting yielded and received values, replacing Yields and Receives sections:
4450
def generator() -> Generator[
4551
Annotated[int, Doc("Yielded integers.")],

0 commit comments

Comments
 (0)