From 2b7b5334116d4bf8d7a62272cdd945aa6a106981 Mon Sep 17 00:00:00 2001 From: Joshua Harlow Date: Fri, 19 Jun 2015 21:44:43 -0700 Subject: [PATCH] Add doc warning to engine components 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 --- doc/source/engines.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/doc/source/engines.rst b/doc/source/engines.rst index abdbdb62..f119f50a 100644 --- a/doc/source/engines.rst +++ b/doc/source/engines.rst @@ -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