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
16 lines
441 B
ReStructuredText
16 lines
441 B
ReStructuredText
-----
|
|
Utils
|
|
-----
|
|
|
|
.. warning::
|
|
|
|
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 though may be used:
|
|
|
|
.. autoclass:: taskflow.utils.misc.Failure
|
|
.. autoclass:: taskflow.utils.eventlet_utils.GreenExecutor
|
|
.. automodule:: taskflow.utils.persistence_utils
|