diff options
| author | Jenkins <jenkins@review.openstack.org> | 2014-06-01 22:19:56 +0000 |
|---|---|---|
| committer | Gerrit Code Review <review@openstack.org> | 2014-06-01 22:19:56 +0000 |
| commit | c8a281aa360117a03baecb38bde411a990b50551 (patch) | |
| tree | 2285c8e870e658bee0e9ad4f803182930685fc84 | |
| parent | 2157791295de7fc96f7ad1ffc81f12b060fd4477 (diff) | |
| parent | 76d3d06f7ece80108252a8c5144b750bf28d0b79 (diff) | |
| download | taskflow-0.3.tar.gz | |
Merge "Warn about internal helper/utility usage"0.3
| -rw-r--r-- | doc/source/utils.rst | 21 |
1 files changed, 6 insertions, 15 deletions
diff --git a/doc/source/utils.rst b/doc/source/utils.rst index 87f3727..75fe91b 100644 --- a/doc/source/utils.rst +++ b/doc/source/utils.rst @@ -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 |