63aa951531
Instead of linking to other topics (which then uses the name of those topics as the link name) define a name that makes more sense for the inline usage and retain the link to the document using wording that fits the surronding text. Also adjust the futures/executor links to point to the external links documenting these features. Change-Id: I5a89e2f747dfec2505947f25c124b157271c07cf
31 lines
977 B
ReStructuredText
31 lines
977 B
ReStructuredText
------------------------
|
|
Atoms, Tasks and Retries
|
|
------------------------
|
|
|
|
An atom is the smallest unit in taskflow which acts as the base for other
|
|
classes. Atoms have a name and a version (if applicable). An atom is expected
|
|
to name desired input values (requirements) and name outputs (provided
|
|
values), see the :doc:`arguments and results <arguments_and_results>` page for
|
|
a complete reference about these inputs and outputs.
|
|
|
|
.. automodule:: taskflow.atom
|
|
|
|
Task
|
|
=====
|
|
|
|
A task (derived from an atom) is the smallest possible unit of work that can
|
|
have an execute & rollback sequence associated with it.
|
|
|
|
.. automodule:: taskflow.task
|
|
|
|
Retry
|
|
=====
|
|
|
|
A retry (derived from an atom) is a special unit that handles flow errors,
|
|
controls flow execution and can retry atoms with another parameters if needed.
|
|
It is useful to allow for alternate ways of retrying atoms when they fail so
|
|
the whole flow can proceed even when a group of atoms fail.
|
|
|
|
.. automodule:: taskflow.retry
|
|
|