From 76d3d06f7ece80108252a8c5144b750bf28d0b79 Mon Sep 17 00:00:00 2001 From: Joshua Harlow Date: Sat, 31 May 2014 22:04:03 -0700 Subject: Warn about internal helper/utility usage 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 --- doc/source/utils.rst | 21 ++++++--------------- 1 file 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 -- cgit v1.2.1