openstack/deb-python-taskflow
Code Issues Proposed changes
Files
f368c5822ee876c8359cbe1cfbfaa6ddf1c6283c
deb-python-taskflow/doc/source/atoms.rst
Ivan A. Melnikov 3ece5c7a9c docs: Add page describing atom arguments and results 
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
2014-03-13 22:07:59 +04:00

547 B
Raw Blame History

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 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.

taskflow.atom

taskflow.task