Skip to content

Commit d2c612d

Browse files
committed
some improvements to some docstrings
1 parent 189561e commit d2c612d

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

effect/_intents.py

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,14 +30,15 @@ class ParallelEffects(object):
3030
An effect intent that asks for a number of effects to be run in parallel,
3131
and for their results to be gathered up into a sequence.
3232
33-
:func:`effect.async.perform_parallel_async` can perform this Intent
34-
assuming all child effects have asynchronous performers.
33+
:func:`effect.async.perform_parallel_async` can perform this Intent assuming
34+
all child effects have asynchronous performers.
35+
:func:`effect.threads.perform_parallel_with_pool` can perform blocking
36+
performers in a thread pool.
3537
3638
Note that any performer for this intent will need to be compatible with
3739
performers for all of its child effects' intents. Notably, if child effects
38-
have blocking performers, it's useless to use
39-
:func:`effect.async.perform_parallel_async`, and if they're asynchronous,
40-
it's useless to perform them with a threaded performer.
40+
have blocking performers, the threaded performer should be used, and if
41+
they're asynchronous, the asynchronous performer should be used.
4142
4243
Performers of this intent must fail with a :obj:`FirstError` exception when
4344
any child effect fails, representing the first error.
@@ -57,6 +58,9 @@ def parallel(effects):
5758
:obj:`FirstError` exception. If additional error information is desired,
5859
use :func:`parallel_all_errors`.
5960
61+
This is just a convenience wrapper for returning of Effect of
62+
:obj:`ParallelEffects`.
63+
6064
:param effects: Effects which should be performed in parallel.
6165
:return: An Effect that results in a list of results, or which fails with
6266
a :obj:`FirstError`.
@@ -70,6 +74,10 @@ def parallel_all_errors(effects):
7074
all of their effects. The result of the aggregate Effect will be a list of
7175
their results, in the same order as the input to this function.
7276
77+
This is like :func:`parallel`, but it differs in that exceptions from all
78+
child effects will be accumulated and provided in the return value, instead
79+
of just the first one.
80+
7381
:param effects: Effects which should be performed in parallel.
7482
:return: An Effect that results in a list of ``(is_error, result)`` tuples,
7583
where ``is_error`` is True if the child effect raised an exception, in

0 commit comments

Comments
 (0)