From 40ea2ce01a06ab68fee31be61bea4722e4e69b36 Mon Sep 17 00:00:00 2001 From: val Date: Mon, 22 Apr 2024 09:21:41 -0400 Subject: [PATCH 1/4] Update class_btsubtree.rst Added a note about updating `subtree` at runtime. --- doc/source/classes/class_btsubtree.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/source/classes/class_btsubtree.rst b/doc/source/classes/class_btsubtree.rst index a04ef1e..8306b39 100644 --- a/doc/source/classes/class_btsubtree.rst +++ b/doc/source/classes/class_btsubtree.rst @@ -14,6 +14,8 @@ BTSubtree BT decorator that instantiates and runs a subtree within the larger tree. +Note: BTSubTree is design as a simpler loader, and does not support changing `subtree` at runtime. A custom subtree decorator is better suited and `somewhat trivial `_ to implement. + .. rst-class:: classref-introduction-group Description From f45e954e62b6775f2e66be21d1f870efce5b7813 Mon Sep 17 00:00:00 2001 From: val Date: Mon, 22 Apr 2024 09:24:24 -0400 Subject: [PATCH 2/4] Update class_btsubtree.rst --- doc/source/classes/class_btsubtree.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/source/classes/class_btsubtree.rst b/doc/source/classes/class_btsubtree.rst index 8306b39..5fce9fd 100644 --- a/doc/source/classes/class_btsubtree.rst +++ b/doc/source/classes/class_btsubtree.rst @@ -14,7 +14,7 @@ BTSubtree BT decorator that instantiates and runs a subtree within the larger tree. -Note: BTSubTree is design as a simpler loader, and does not support changing `subtree` at runtime. A custom subtree decorator is better suited and `somewhat trivial `_ to implement. +Note: BTSubTree is designed as a simpler loader, and does not support updating `subtree` at runtime. A custom subtree decorator is better suited and `somewhat trivial `_ to implement. .. rst-class:: classref-introduction-group From 40850067c888c84c36d28568665e43f0719e0cea Mon Sep 17 00:00:00 2001 From: val Date: Mon, 22 Apr 2024 12:58:44 -0400 Subject: [PATCH 3/4] moved the change to the doc sources --- doc/source/classes/class_btsubtree.rst | 4 ++-- doc_classes/BTSubtree.xml | 1 + 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/doc/source/classes/class_btsubtree.rst b/doc/source/classes/class_btsubtree.rst index 5fce9fd..21885c4 100644 --- a/doc/source/classes/class_btsubtree.rst +++ b/doc/source/classes/class_btsubtree.rst @@ -14,8 +14,6 @@ BTSubtree BT decorator that instantiates and runs a subtree within the larger tree. -Note: BTSubTree is designed as a simpler loader, and does not support updating `subtree` at runtime. A custom subtree decorator is better suited and `somewhat trivial `_ to implement. - .. rst-class:: classref-introduction-group Description @@ -25,6 +23,8 @@ BTSubtree instantiates a :ref:`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 `subtree` at runtime. A custom subtree decorator is better suited and somewhat trivial to implement (https://github.com/limbonaut/limboai/issues/94#issuecomment-2068833610). + .. rst-class:: classref-reftable-group Properties diff --git a/doc_classes/BTSubtree.xml b/doc_classes/BTSubtree.xml index de90388..736c25e 100644 --- a/doc_classes/BTSubtree.xml +++ b/doc_classes/BTSubtree.xml @@ -6,6 +6,7 @@ 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 `subtree` at runtime. A custom subtree decorator is better suited and somewhat trivial to implement (https://github.com/limbonaut/limboai/issues/94#issuecomment-2068833610). From 29d4b92bf4771cd7d182d5cfa32b91ec3e19ba65 Mon Sep 17 00:00:00 2001 From: val Date: Mon, 22 Apr 2024 13:52:09 -0400 Subject: [PATCH 4/4] found how to get custom links into the doc --- doc/source/classes/class_btsubtree.rst | 2 +- doc_classes/BTSubtree.xml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/source/classes/class_btsubtree.rst b/doc/source/classes/class_btsubtree.rst index 21885c4..f64b81a 100644 --- a/doc/source/classes/class_btsubtree.rst +++ b/doc/source/classes/class_btsubtree.rst @@ -23,7 +23,7 @@ BTSubtree instantiates a :ref:`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 `subtree` at runtime. A custom subtree decorator is better suited and somewhat trivial to implement (https://github.com/limbonaut/limboai/issues/94#issuecomment-2068833610). +Note: BTSubTree is designed as a simpler loader, and does not support updating :ref:`subtree` at runtime. A custom subtree decorator is better suited and `somewhat trivial `__ to implement. .. rst-class:: classref-reftable-group diff --git a/doc_classes/BTSubtree.xml b/doc_classes/BTSubtree.xml index 736c25e..e25a9d6 100644 --- a/doc_classes/BTSubtree.xml +++ b/doc_classes/BTSubtree.xml @@ -6,7 +6,7 @@ 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 `subtree` at runtime. A custom subtree decorator is better suited and somewhat trivial to implement (https://github.com/limbonaut/limboai/issues/94#issuecomment-2068833610). + 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.