From c0ef145d895fa08e2279d63de786dc0f888f71be Mon Sep 17 00:00:00 2001 From: Dan Rose Date: Thu, 8 Aug 2019 12:21:12 -0500 Subject: [PATCH] Address PR feedback Signed-off-by: Dan Rose --- rclcpp/include/rclcpp/executor.hpp | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/rclcpp/include/rclcpp/executor.hpp b/rclcpp/include/rclcpp/executor.hpp index 0bde0addc8..7e156be44c 100644 --- a/rclcpp/include/rclcpp/executor.hpp +++ b/rclcpp/include/rclcpp/executor.hpp @@ -211,8 +211,8 @@ class Executor /// Spin (blocking) until the future is complete, it times out waiting, or rclcpp is interrupted. /** - * \param[in] future The future to wait on. If SUCCESS, the future is safe to access after this - * function. + * \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. * `-1` is block forever, `0` is non-blocking. * If the time spent inside the blocking loop exceeds this timeout, return a TIMEOUT return