Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit dd98ecc

Browse files
committed
docs fixed
1 parent aee6327 commit dd98ecc

File tree

1 file changed

+18
-16
lines changed

1 file changed

+18
-16
lines changed

docs/MigrationGuide.md

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@ __System Integrator__.
77

88
In practice, this means that:
99

10-
- Custom Actions (or, in general, custom TreeNodes) must be reusable building
10+
- Custom Actions (or, in general, custom TreeNodes) must be __reusable__ building
1111
blocks. Implement them once, reuse them many times.
1212

13-
- To build a Behavior Tree out of TreeNodes, the Behavior Designer must
14-
not need to read nor modify the source code of the a given TreeNode.
13+
- To build a Behavior Tree out of TreeNodes, the Behavior Designer __must
14+
not need to read nor modify the source code__ of the a given TreeNode.
1515

16-
There is a __major design flaw__ that undermines this goal in version `2.x`:
16+
There was a major design flaw that undermined these goals in version `2.x`:
1717
the way the BlackBoard was used to implement DataFlow between nodes.
1818

1919
As described in [issue #18](https://github.com/BehaviorTree/BehaviorTree.CPP/issues/18)
@@ -72,17 +72,19 @@ shared __key/value__ table, i.e. a glorified bunch of global variables.
7272
The key is a `string`, whilst the value is
7373
stored in a type-safe container similar to `std::any` or `std::variant`.
7474
75-
The problem is that writing/reading in an entry of the BB is done __implicitly__
76-
in the source code and it is usually hard-coded. This makes the TreeNode
75+
The problem is that writing/reading in an entry of the BB was done __implicitly__
76+
in the source code and it was usually hard-coded. This made the TreeNode
7777
not reusable.
7878
7979
To fix this, we still use the Blackboard under the hood, but it can not be
80-
accessed directly anymore. Entries are read/written using respectively `InputPorts`
81-
and `OutputPorts`.
80+
accessed directly anymore.
8281
83-
These ports __must be modelled__ to allow remapping at run-time.
82+
In version `3.x`Blackboard entries can be read/written using respectively
83+
`InputPorts` and `OutputPorts`.
8484
85-
Let's take a look to an example at the old code:
85+
These ports __must be defined explicitly__ to allow remapping at run-time.
86+
87+
Let's take a look to an example writte using the __old__ code:
8688
8789
```XML
8890
<root>
@@ -143,7 +145,7 @@ and modify it.
143145
In other words, `NodeParameter` is already a reasonably good implementation
144146
of an `InputPort`, but we need to introduce a consistent `OutputPort` too.
145147
146-
This is the new code:
148+
This is the __new__ code:
147149
148150
```XML
149151
<root>
@@ -246,7 +248,7 @@ remapping in the XML definition. No C++ code need to be modified.
246248
From the point of view of the XML, remapped ports of a SubTree looks exactly
247249
like the ports of a single node.
248250
249-
For more details, refer to the example __t06_subtree_port_remapping.cpp_.
251+
For more details, refer to the example __t06_subtree_port_remapping.cpp__.
250252
251253
252254
## ControlNodes renamed/refactored
@@ -271,17 +273,17 @@ By "reactive" we mean that:
271273
272274
273275
The main concern of the original author of this library was to build reactive
274-
Behavior Trees (see for reference this [publication](0https://arxiv.org/abs/1709.00084).
276+
Behavior Trees (see for reference this [publication](0https://arxiv.org/abs/1709.00084)).
275277
276278
I share this goal, but I prefer to have more explicit names, because reactive
277279
ControlNodes are useful but hard to reason about sometimes.
278280
279-
I don't think reactive Controlnodes should be the mindlessly by default.
281+
I don't think reactive ControlNodes should be used mindlessly by default.
280282
281283
For instance, most of the time users I talked with should have used `SequenceStar`
282284
instead of `Sequence` in many cases.
283285
284-
I renamed the ControlNodes to reflect this reality:
286+
I renamed the ControlNodes as follows to reflect this reality:
285287
286288
287289
| Old Name (v2) | New name (v3) | Is reactive? |
@@ -302,7 +304,7 @@ more than a single asynchronous child.
302304
303305
The new recommendation is:
304306
305-
>__Reactive nodes shouldn't have more than a single asynchronous child__.
307+
>__Reactive nodes should NOT have more than a single asynchronous child__.
306308
307309
This is a very opinionated decision and for this reason it is documented but
308310
not enforced by the implementation.

0 commit comments

Comments
 (0)