Files

Joshua Harlow f2c82f0929 Doc adjustments

- Cleanup some grammar and adjust some wording usage.
- Add more docs to utils about what should and should
  not be used.
- Add more engine docs about how each one is used and
  tips and notes about each.
- Line length adjustments (might as well keep it somewhat
  in the normal range of what openstack code expects)

Change-Id: Ice6711f00e2b50e0bee777388c0555d79cc6e1b0

2014-04-11 12:36:26 -07:00

938 B

Raw Blame History

Utils

There are various helper utils that are part of taskflows internal usage (and external/public usage of these helpers should be kept to a minimum as these utility functions may be altered more often in the future).

External usage

The following classes and modules are recommended for external usage:

taskflow.utils.misc.Failure

taskflow.utils.eventlet_utils.GreenExecutor

taskflow.utils.graph_utils.pformat

taskflow.utils.graph_utils.export_graph_to_dot

taskflow.utils.persistence_utils.temporary_log_book

taskflow.utils.persistence_utils.temporary_flow_detail

taskflow.utils.persistence_utils.pformat

taskflow.utils.persistence_utils.pformat_flow_detail

taskflow.utils.persistence_utils.pformat_atom_detail

938 B Raw Blame History

Utils

External usage

938 B

Raw Blame History