Merge pull request #96 from onze/patch-1

Documentation update - BTSubTree
limbonaut · Apr 22, 2024 · 2bfedec · 2bfedec
2 parents af0250d + 29d4b92
commit 2bfedec
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/doc/source/classes/class_btsubtree.rst b/doc/source/classes/class_btsubtree.rst
@@ -23,6 +23,8 @@ BTSubtree instantiates a :ref:`BehaviorTree<class_BehaviorTree>` and includes it
 
 Returns the status of the subtree's execution.
 
+Note: BTSubTree is designed as a simpler loader, and does not support updating :ref:`subtree<class_BTSubtree_property_subtree>` at runtime. A custom subtree decorator is better suited and `somewhat trivial <https://github.com/limbonaut/limboai/issues/94#issuecomment-2068833610>`__ to implement.
+
 .. rst-class:: classref-reftable-group
 
 Properties

diff --git a/doc_classes/BTSubtree.xml b/doc_classes/BTSubtree.xml
@@ -6,6 +6,7 @@
 	<description>
 		BTSubtree instantiates a [BehaviorTree] and includes its root task as a child during initialization, while also creating a new [Blackboard] scope.
 		Returns the status of the subtree's execution.
+		Note: BTSubTree is designed as a simpler loader, and does not support updating [member subtree] at runtime. A custom subtree decorator is better suited and [url=https://github.com/limbonaut/limboai/issues/94#issuecomment-2068833610]somewhat trivial[/url] to implement.
 	</description>
 	<tutorials>
 	</tutorials>