f2c82f0929
- 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
33 lines
938 B
ReStructuredText
33 lines
938 B
ReStructuredText
-----
|
|
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:
|
|
|
|
.. autoclass:: taskflow.utils.misc.Failure
|
|
:members:
|
|
|
|
.. autoclass:: taskflow.utils.eventlet_utils.GreenExecutor
|
|
:members:
|
|
|
|
.. autofunction:: taskflow.utils.graph_utils.pformat
|
|
|
|
.. autofunction:: taskflow.utils.graph_utils.export_graph_to_dot
|
|
|
|
.. autofunction:: taskflow.utils.persistence_utils.temporary_log_book
|
|
|
|
.. autofunction:: taskflow.utils.persistence_utils.temporary_flow_detail
|
|
|
|
.. autofunction:: taskflow.utils.persistence_utils.pformat
|
|
|
|
.. autofunction:: taskflow.utils.persistence_utils.pformat_flow_detail
|
|
|
|
.. autofunction:: taskflow.utils.persistence_utils.pformat_atom_detail
|