Update documentation for reactive sequence (BehaviorTree#286)

matthews-jca · web-flow · commit bd6e227bb493 · 2021-07-11T10:15:29.000+02:00
diff --git a/include/behaviortree_cpp_v3/controls/reactive_sequence.h b/include/behaviortree_cpp_v3/controls/reactive_sequence.h
@@ -21,7 +21,7 @@ namespace BT
  * @brief The ReactiveSequence is similar to a ParallelNode.
  * All the children are ticked from first to last:
  *
- * - If a child returns RUNNING, tick the next sibling.
+ * - If a child returns RUNNING, halt the remaining siblings in the sequence and return RUNNING.
  * - If a child returns SUCCESS, tick the next sibling.
  * - If a child returns FAILURE, stop and return FAILURE.
  *

Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ namespace BT`
`21`	`21`	`* @brief The ReactiveSequence is similar to a ParallelNode.`
`22`	`22`	`* All the children are ticked from first to last:`
`23`	`23`	`*`
`24`		`- * - If a child returns RUNNING, tick the next sibling.`
	`24`	`+ * - If a child returns RUNNING, halt the remaining siblings in the sequence and return RUNNING.`
`25`	`25`	`* - If a child returns SUCCESS, tick the next sibling.`
`26`	`26`	`* - If a child returns FAILURE, stop and return FAILURE.`
`27`	`27`	`*`