From 8d8096b6d8f781d4fb234c58589195a0ffbe3956 Mon Sep 17 00:00:00 2001 From: David Wilson Date: Fri, 29 Sep 2017 13:37:11 +0530 Subject: [PATCH] docs: fix :return: syntax. --- docs/api.rst | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/docs/api.rst b/docs/api.rst index 510f7072..32e47797 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -422,9 +422,9 @@ Context Class :param mitogen.core.Message msg: The message. - :return mitogen.core.Receiver: - Receiver configured to receive any replies sent to the message's - `reply_to` handle. + :returns: + :py:class:`mitogen.core.Receiver` configured to receive any replies + sent to the message's `reply_to` handle. .. method:: send_await (msg, deadline=None) @@ -487,8 +487,9 @@ Context Class :param dict kwargs: Function keyword arguments, if any. See :ref:`serialization-rules` for permitted types. - :return mitogen.core.Receiver: - A receiver configured to receive the result of the invocation: + :returns: + :py:class:`mitogen.core.Receiver` configured to receive the result + of the invocation: .. code-block:: python @@ -503,7 +504,7 @@ Context Class Equivalent to :py:meth:`call_async(fn, \*args, \**kwargs).get_data() `. - :return: + :returns: The function's return value. :raises mitogen.core.CallError: