From 2c0244eea71132b81c39d8a14c088a30d549fb5a Mon Sep 17 00:00:00 2001 From: David Wilson Date: Sun, 9 Sep 2018 23:51:48 +0100 Subject: [PATCH] docs: more tweaks --- docs/api.rst | 8 ++++---- docs/changelog.rst | 32 ++++++++++++++++---------------- 2 files changed, 20 insertions(+), 20 deletions(-) diff --git a/docs/api.rst b/docs/api.rst index 4ad1db5e..cb980b55 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -1094,11 +1094,11 @@ Select Class .. code-block:: python - sum(context.call_async(get_disk_usage).get().unpickle() - for context in contexts) + recvs = [c.call_async(get_disk_usage) for c in contexts] + sum(recv.get().unpickle() for recv in recvs) - Result processing happens concurrently to new results arriving, so - :meth:`all` should always be faster. + Result processing happens in the order results arrive, rather than the + order requests were issued, so :meth:`all` should always be faster. .. py:method:: get (timeout=None, block=True) diff --git a/docs/changelog.rst b/docs/changelog.rst index 818242ca..20ed9a5d 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -61,9 +61,9 @@ Enhancements * `5189408e `_: threads are cooperatively scheduled, minimizing `GIL `_ contention, and - reducing context switching by an order of magnitude. This manifests as an - overall improvement, but is easily noticeable on short many-target - runs, where startup overhead dominates runtime. + reducing context switching by around 90%. This manifests as an overall + improvement, but is easily noticeable on short many-target runs, where + startup overhead dominates runtime. Fixes @@ -109,9 +109,9 @@ Fixes Ansible's behaviour. * `#355 `_: tasks configured to run - in an isolated forked subprocess were being forked from the wrong parent - context. This meant built-in modules overridden via a custom ``module_utils`` - search path may not have had any effect. + in an isolated forked subprocess were forked from the wrong parent context. + This meant built-in modules overridden via a custom ``module_utils`` search + path may not have had any effect. * A missing check caused an exception traceback to appear when using the ``ansible`` command-line tool with a missing or misspelled module name. @@ -126,15 +126,19 @@ Fixes Core Library ~~~~~~~~~~~~ +* A new :class:`mitogen.parent.CallChain` class abstracts safe pipelining of + related function calls to a target context, cancelling the chain if an + exception occurs. + * `#305 `_: fix a long-standing minor - race relating to the logging framework, where *no route for Message(...)(* - would appear fruequently during startup. + race relating to the logging framework, where *no route for Message..* + would frequently appear during startup. * `#313 `_: - :meth:`mitogen.parent.Context.call` was accidentally documented as capable of - accepting static methods. While possible on Python 2.x the result is ugly, - and in every case it should be trivial to replace with a classmethod. The - documentation was fixed. + :meth:`mitogen.parent.Context.call` was documented as capable of accepting + static methods. While possible on Python 2.x the result is ugly, and in every + case it should be trivial to replace with a classmethod. The documentation + was fixed. * `#337 `_: to avoid a scaling limitation, SSH no longer allocates a PTY for every OpenSSH client. PTYs are @@ -161,10 +165,6 @@ Core Library listener no longer crashes if the peer process disappears in the middle of connection setup. -* A new :class:`mitogen.parent.CallChain` class abstracts safe pipelining of - overlapping chains of related function calls to a target context, - cancelling the chain if an exception occurs. - Thanks! ~~~~~~~