docs: link signals into internals.rst.

This commit is contained in:
David Wilson 2018-05-04 03:47:29 +01:00
parent 1bc08323bf
commit 43e9e51ed6
2 changed files with 21 additions and 1 deletions

View File

@ -2,6 +2,11 @@
Internal API Reference
**********************
.. toctree::
:hidden:
signals
mitogen.core
============
@ -462,3 +467,9 @@ Helper Functions
:returns str:
The minimized source.
Signals
=======
:ref:`Please refer to Signals <signals>`.

View File

@ -1,11 +1,20 @@
.. _signals:
Signals
=======
Mitogen exposes a simplistic signal mechanism to help decouple its internal
Mitogen contains a simplistic signal mechanism to help decouple its internal
components. When a signal is fired by a particular instance of a class, any
functions registered to receive it will be called back.
.. warning::
As signals execute on the Broker thread, and without exception handling,
they are generally unsafe for consumption by user code, as any bugs could
trigger crashes and hangs for which the broker is unable to forward logs,
or ensure the buggy context always shuts down on disconnect.
Functions
---------