Skip to content

Commit

Permalink
change docs to express what is possible instead of what is not
Browse files Browse the repository at this point in the history
Co-authored-by: Tomoya Fujita <[email protected]>
Signed-off-by: Matthias Holoch <[email protected]>
  • Loading branch information
Cakem1x and fujitatomoya committed Apr 5, 2024
1 parent d91e9f4 commit 17929ce
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion rclcpp/include/rclcpp/executor.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -347,7 +347,7 @@ class Executor

/// Spin (blocking) until the future is complete, it times out waiting, or rclcpp is interrupted.
/**
* Handles one work item after the other, hence, it does not support parallel processing.
* The implementation is suitable for a single-thread model of execution.
* \param[in] future The future to wait on. If this function returns SUCCESS, the future can be
* accessed without blocking (though it may still throw an exception).
* \param[in] timeout Optional timeout parameter, which gets passed to Executor::spin_node_once.
Expand Down

0 comments on commit 17929ce

Please sign in to comment.