Skip to content

Commit 8f53b36

Browse files
committed
correct docs
1 parent b1d85b7 commit 8f53b36

File tree

4 files changed

+8
-8
lines changed

4 files changed

+8
-8
lines changed

docs/asynchronous_nodes.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -177,9 +177,10 @@ class BadSleepNode : public BT::AsyncActionNode
177177
return NodeStatus::SUCCESS;
178178
}
179179

180-
// The halt() method can not kill the spawned thread :()
181-
// void halt();
182-
}
180+
// The halt() method can not kill the spawned thread :(
181+
182+
// Keep in mind that most of the time we should not
183+
// override AsyncActionNode::halt()
183184
};
184185
```
185186

docs/getting_started.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,7 @@ Alternatively, the library provides a mechanism to create a TreeNode passing a
4444
__function pointer__ to a wrapper (dependency injection).
4545

4646
This approach reduces the amount of boilerplate in your code; as a reference
47-
please look at the [first tutorial](tutorial_01_first_tree.md) and the one
48-
describing [non intrusive integration with legacy code](tutorial_07_legacy.md).
47+
please look at the [first tutorial](tutorial_01_first_tree.md).
4948

5049
## Dataflow, Ports and Blackboard
5150

docs/tutorial_07_multiple_xml.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ If multiple Subtrees were used, they were all included into the same XML.
88
In recent version of BT.CPP (3.7+), the user can more easily
99
load trees from multiple files, if needed.
1010

11-
## Using the \<include\> tag
11+
## Load multiple files with "include"
1212

1313
We will consider a main tree that invoke 2 different subtrees.
1414

@@ -56,7 +56,7 @@ We need to create the tree as usual:
5656
factory.createTreeFromFile("main_tree.xml")
5757
```
5858

59-
## Load multiple files without \<include\>
59+
## Load multiple files manually
6060

6161
If we don't want to add relative and hard-coded paths into our XML,
6262
or if we want to instantiate a subtree instead of the main tree, there is a

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ nav:
4848
- "Tutorial 4: Reactive Trees": tutorial_04_sequence.md
4949
- "Tutorial 5: Subtrees and Loggers": tutorial_05_subtrees.md
5050
- "Tutorial 6: Ports remapping": tutorial_06_subtree_ports.md
51-
- "Tutorial 7: Load from multiple XMLs": tutorial_07_multiple_xml.md
51+
- "Tutorial 7: Load multiple XMLs": tutorial_07_multiple_xml.md
5252
- "Tutorial 8: Additional arguments": tutorial_08_additional_args.md
5353
- "Tutorial 9: Coroutines": tutorial_09_coroutines.md
5454

0 commit comments

Comments
 (0)