docs: Disambiguate references to Context

This addresses an error found while running tox -edocs

Warning, treated as error:
mitogen/docs/api.rst:469:more than one target found for cross-reference
u'Context': mitogen.core.Context, mitogen.parent.Context
pull/386/head
Alex Willmer 6 years ago
parent 191a327d9d
commit bf34b383eb

@ -458,7 +458,7 @@ Router Class
rich data structures that cannot normally be passed via a rich data structures that cannot normally be passed via a
serialization. serialization.
:param Context via: :param mitogen.core.Context via:
Same as the `via` parameter for :meth:`local`. Same as the `via` parameter for :meth:`local`.
:param bool debug: :param bool debug:
@ -1078,7 +1078,8 @@ Select Class
each, returning the result of calling `msg.unpickle()` on each in turn. each, returning the result of calling `msg.unpickle()` on each in turn.
Results are returned in the order they arrived. Results are returned in the order they arrived.
This is sugar for handling batch :class:`Context.call_async` This is sugar for handling batch
:meth:`Context.call_async <mitogen.parent.Context.call_async>`
invocations: invocations:
.. code-block:: python .. code-block:: python
@ -1245,7 +1246,8 @@ Broker Class
.. method:: keep_alive .. method:: keep_alive
Return :data:`True` if any reader's :attr:`Side.keep_alive` Return :data:`True` if any reader's :attr:`Side.keep_alive`
attribute is :data:`True`, or any :class:`Context` is still attribute is :data:`True`, or any
:class:`Context <mitogen.core.Context>` is still
registered that is not the master. Used to delay shutdown while some registered that is not the master. Used to delay shutdown while some
important work is in progress (e.g. log draining). important work is in progress (e.g. log draining).

@ -208,7 +208,7 @@ started the context, however as shown, this can be overridden.
Calling A Function Calling A Function
------------------ ------------------
.. currentmodule:: mitogen.master .. currentmodule:: mitogen.parent
Now that some contexts exist, it is time to execute code in them. Any regular Now that some contexts exist, it is time to execute code in them. Any regular
function, static method, or class method reachable directly from module scope function, static method, or class method reachable directly from module scope

Loading…
Cancel
Save