3ece5c7a9c
Task Arguments and Results page from wiki converted to sphinx/rst and edited to improve readability and make it look better. Some examples are converted to doctest. We also now check doctests from docs for correctness when unit tests are run by tox. Partially implements blueprint sphinx-docs. Change-Id: Ief398856e1ce2d0dc1d43c4e4112872a27672fcf
17 lines
547 B
ReStructuredText
17 lines
547 B
ReStructuredText
---------------
|
|
Atoms and Tasks
|
|
---------------
|
|
|
|
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). Atom are expected
|
|
to name desired input values (requirements) and name outputs (provided
|
|
values), see :doc:`arguments_and_results` page for complete reference
|
|
about it.
|
|
|
|
A task (derived from an atom) is the smallest possible unit of work that can
|
|
have a execute & rollback sequence associated with it.
|
|
|
|
.. automodule:: taskflow.atom
|
|
|
|
.. automodule:: taskflow.task
|