From 75b9e1d71e0b0ad9d6d7816152902369813019db Mon Sep 17 00:00:00 2001 From: David Wilson Date: Sat, 24 Mar 2018 15:57:03 +0545 Subject: [PATCH] issue #155: docs: document behaviour of forked children --- docs/api.rst | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/docs/api.rst b/docs/api.rst index 035954da..30ccadf8 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -2,6 +2,11 @@ API Reference ************* +.. toctree:: + :hidden: + + signals + Package Layout ============== @@ -516,7 +521,11 @@ Router Class .. method:: fork (new_stack=False, debug=False, profiling=False) Construct a context on the local machine by forking the current - process. The associated stream implementation is + process. The forked child receives a new identity, sets up a new broker + and router, and responds to function calls identically, just like + children created using any other method. + + The associated stream implementation is :py:class:`mitogen.fork.Stream`. :param bool new_stack: