openstack/deb-python-taskflow
Code Issues Proposed changes

Warn about internal helper/utility usage

Browse Source 
Adjust the utils doc and add in a warning that
lets users know that the internal functions and
modules that appear to be utility related should
not be used externally (and if they use these they
are using them at their own risk).

Change-Id: I5d813028c8c7f35359853cab45fcdc8454bbf6fd
This commit is contained in:
Joshua Harlow
2014-05-31 22:04:03 -07:00
committed by Thomas Goirand
parent ab9b56a7fd
commit cd62caa815
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