Skip to content

Correction for named Functor As it was creating confusion and may mislead new learners. #65

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Subh85330 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Correction for named Functor As it was creating confusion and may mislead new learners. #65

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/tutorial-basics/tutorial_01_first_tree.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,9 @@ As you can see:
It must always return a `NodeStatus`, i.e. RUNNING, SUCCESS or FAILURE.

Alternatively, we can use __dependency injection__ to create a TreeNode given
a function pointer (i.e. "functor").
a function pointer.

The functor must have this signature:
The Functions (to use as a function pointer) must have this signature:

``` cpp
BT::NodeStatus myFunction(BT::TreeNode& self)
Expand Down Expand Up @@ -98,7 +98,7 @@ private:

```

We can build a `SimpleActionNode` from any of these functors:
We can build a `SimpleActionNode` from any of these functions:

- CheckBattery()
- GripperInterface::open()
Expand Down