Skip to content

Commit b27b157

Browse files
committed
Further improve documentation
1 parent fd7e64e commit b27b157

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

docs/tasks.rst

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,11 +45,11 @@ Return values
4545
Machine tasks have three different allowed return values all of which will
4646
cause the process to behave differently:
4747

48-
``None``:
48+
:class:`None`:
4949
If a task returns ``None`` or anything at all the process will just
5050
proceed as planed and follow all outgoing edges and execute the nexttasks.
5151

52-
``Iterable``:
52+
:class:`Iterable`:
5353
A task can return also an explicit list of tasks that should be executed
5454
next. This can be used to create exclusive gateways::
5555

@@ -84,7 +84,10 @@ cause the process to behave differently:
8484
A task can also return am empty list. This will cause the process branch
8585
to come to a halt and no further stats will be started.
8686

87-
``False``:
87+
.. warning::
88+
A task can not be a generator (*yield* results).
89+
90+
:class:`False`:
8891
A task can also return a boolean. Should a task return ``False`` the
8992
process will wait until the condition changes to ``True`` (or anything but
9093
``False``)::

0 commit comments

Comments
 (0)