openstack/deb-python-taskflow
Code Issues Proposed changes

Merge "Warn about internal helper/utility usage"

Browse Source
This commit is contained in:
Jenkins
2014-06-01 22:19:56 +00:00
committed by Gerrit Code Review
parent 2157791295 76d3d06f7e
commit c8a281aa36
1 changed files with 6 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
doc/source/utils.rst
View File

@@ -2,23 +2,14 @@
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).
.. warning::
External usage
==============
External usage of internal helpers and other internal utility functions
and modules should be kept to a *minimum* as these may be altered,
refactored or moved *without* notice.
The following classes and modules are *recommended* for external usage:
The following classes and modules though may be used:
.. autoclass:: taskflow.utils.misc.Failure
:members:
.. autoclass:: taskflow.utils.eventlet_utils.GreenExecutor
:members:
.. autofunction:: taskflow.utils.persistence_utils.temporary_log_book
.. autofunction:: taskflow.utils.persistence_utils.temporary_flow_detail
.. autofunction:: taskflow.utils.persistence_utils.pformat
.. automodule:: taskflow.utils.persistence_utils