:return: keyword inside comment

Question

I was writing a comment inside the function and my IDE autocompleted it like this:

async def some_func():
    """

    :return:
    """

What is this :return: used for and where can I read more about this?

https://stackoverflow.com/questions/3898572/what-are-the-most-common-python-docstring-formats (It's reST). — SuperStormer, Feb 05 '22 at 20:26

score 1 · Accepted Answer · answered Feb 05 '22 at 20:29

this is part of the sphinx docstring format (there are many other format types like numpy, google, etc). this link should help describe in detail.

these docstring specification help with auto documentation like you see with many python packages (eg link see "Returns" section)

1 Answers1