openstack/deb-python-taskflow
Code Issues Proposed changes

Add doc warning to engine components

Browse Source 
These components are internal to an engine and should
not be used externally so make sure we add a doc note
that states this (or at least warns about using them
minimally).

There are still useful to document as they are used
in docs that describe how engines work and what they
do.

Change-Id: I9143f5d7114ccedddee602dabff4b48446bd99ff
This commit is contained in:
Joshua Harlow
2015-06-19 21:44:43 -07:00
parent 08c0bbc3e3
commit 2b7b533411
1 changed files with 7 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
doc/source/engines.rst
View File

@@ -441,6 +441,13 @@ Implementations
Components
----------
.. warning::
External usage of internal engine functions, components and modules should
be kept to a **minimum** as they may be altered, refactored or moved to
other locations **without** notice (and without the typical deprecation
cycle).
.. automodule:: taskflow.engines.action_engine.analyzer
.. automodule:: taskflow.engines.action_engine.compiler
.. automodule:: taskflow.engines.action_engine.completer