Fix references to RetryUntilSuccesful (BehaviorTree#308)

* Fix github action * Fix references to RetryUntilSuccesful
rneerg · Oct 13, 2021 · 3c7bea1 · 3c7bea1
1 parent 4c9807a
commit 3c7bea1
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 7 deletions.
diff --git a/docs/tutorial_05_subtrees.md b/docs/tutorial_05_subtrees.md
@@ -23,9 +23,9 @@ It is also the first practical example that uses `Decorators` and `Fallback`.
             <Inverter>
                 <IsDoorOpen/>
             </Inverter>
-            <RetryUntilSuccesful num_attempts="4">
+            <RetryUntilSuccessful num_attempts="4">
                 <OpenDoor/>
-            </RetryUntilSuccesful>
+            </RetryUntilSuccessful>
             <PassThroughDoor/>
         </Sequence>
     </BehaviorTree>

diff --git a/docs/uml/CrossDoorSubtree.uxf b/docs/uml/CrossDoorSubtree.uxf
@@ -53,7 +53,7 @@
       <w>150</w>
       <h>40</h>
     </coordinates>
-    <panel_attributes>RetryUntilSuccesful
+    <panel_attributes>RetryUntilSuccesfful
 (num_attempts=4)</panel_attributes>
     <additional_attributes/>
   </element>

diff --git a/docs/uml/ReadTheDocs.uxf b/docs/uml/ReadTheDocs.uxf
@@ -43,7 +43,7 @@ Robot Behaviors</panel_attributes>
       <w>150</w>
       <h>40</h>
     </coordinates>
-    <panel_attributes>RetryUntilSuccesful</panel_attributes>
+    <panel_attributes>RetryUntilSuccessful</panel_attributes>
     <additional_attributes/>
   </element>
   <element>

diff --git a/examples/t05_crossdoor.cpp b/examples/t05_crossdoor.cpp
@@ -29,9 +29,9 @@ static const char* xml_text = R"(
             <Inverter>
                 <Condition ID="IsDoorOpen"/>
             </Inverter>
-            <RetryUntilSuccesful num_attempts="4">
+            <RetryUntilSuccessful num_attempts="4">
                 <OpenDoor/>
-            </RetryUntilSuccesful>
+            </RetryUntilSuccessful>
             <PassThroughDoor/>
         </Sequence>
     </BehaviorTree>

diff --git a/include/behaviortree_cpp_v3/decorators/retry_node.h b/include/behaviortree_cpp_v3/decorators/retry_node.h
@@ -32,6 +32,10 @@ namespace BT
  * <RetryUntilSuccessful num_attempts="3">
  *     <OpenDoor/>
  * </RetryUntilSuccessful>
+ *
+ * Note:
+ * RetryNodeTypo is only included to support the depricated typo
+ * "RetryUntilSuccesful" (note the single 's' in Succesful)
  */
 class RetryNode : public DecoratorNode
 {
@@ -64,7 +68,7 @@ class RetryNode : public DecoratorNode
 
 class
 [[deprecated("RetryUntilSuccesful was a typo and deprecated, use RetryUntilSuccessful instead.")]]
-RetryNodeTypo : RetryNode{
+RetryNodeTypo : public RetryNode{
   public:
     RetryNodeTypo(const std::string& name, int NTries)
       : RetryNode(name, NTries)