Fix documentation of Context class#2107
Conversation
rclcpp/include/rclcpp/context.hpp
Outdated
| * It is often used in conjunction with rclcpp::NodeOptions::context | ||
| * and rclcpp::shutdown. |
There was a problem hiding this comment.
While this sentence is now technically true, I don't think it is particularly helpful. It doesn't tell the reader how this might be used.
Instead, what I think we should say here is something along the lines of:
Nodes may be attached to a particular context by constructing a Node with an rclcpp::NodeOptions::context set. They will be automatically removed from the context when destructed.
Contexts may be shutdown by calling rclcpp::shutdown.
There was a problem hiding this comment.
I tried to rephrase in 78181fd, feel free to review again!
78181fd to
084b423
Compare
clalancette
left a comment
There was a problem hiding this comment.
One really minor thing (one sentence per line), and this looks good to me.
|
This just needs a proper Signed-off-by line on the last commit, then we'll be good to merge it (assuming the Rpr job comes back green). |
Signed-off-by: Silvio Traversaro <silvio@traversaro.it>
Done, sorry but I got distracted between the "Apply comment of the reviewers" and the rebase for the signoff. |
|
Since this is just a documentation update, I'm going to merge with just the Rpr job. Thanks for the improvement! |
Fix #2106 . I also removed the reference to
rclcpp::initas it does take in input aContext, I added instead the method to call to specify the context to use for a given node, please correct me if I was wrong on that.As an alternative, we can also get rid of that sentence.