Files
openide/python/testData/docstrings/numpyNamedReturnsAndYields.py
Mikhail Golubev a41986b1b4 PY-31025 Properly extract description of the return value in Google docstrings
when both its type and optional name are omitted. Just as the reference implementation
in sphinxcontrib.napoleon we now require a trailing colon on the first line of a field
to treat this text as the return type, otherwise it's considered the return value description.

Also, I dropped support for named return and yield values in Google Code Style docstrings,
as Napoleon doesn't feature them as well.
2018-08-06 18:30:14 +03:00

15 lines
284 B
Python

def func():
"""
Return
------
status_code: int
HTTP status code
template: str
path to template in template roots
Yields
------
progress: float
floating point value in range [0, 1) indicating progress
of the task
"""