Skip to content

Commit 4f3bdef

Browse files
fix comments.
Signed-off-by: Tomoya.Fujita <[email protected]> Co-authored-by: Chris Lalancette <[email protected]>
1 parent 72ba5f8 commit 4f3bdef

File tree

2 files changed

+3
-4
lines changed

2 files changed

+3
-4
lines changed

rclcpp/include/rclcpp/executor.hpp

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -305,8 +305,7 @@ class Executor
305305
* If the time that waitables take to be executed is longer than the period on which new waitables
306306
* become ready, this method will execute work repeatedly until `max_duration` has elapsed.
307307
*
308-
* \param[in] max_duration The maximum amount of time to spend executing work.
309-
* `0` is block forever, must be greater than or equal to 0.
308+
* \param[in] max_duration The maximum amount of time to spend executing work, must be >= 0.
310309
* \throw throw std::invalid_argument if max_duration is less than 0.
311310
* Note that spin_all() may take longer than this time as it only returns once max_duration has
312311
* been exceeded.

rclcpp/include/rclcpp/executors/static_single_threaded_executor.hpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,8 +99,8 @@ class StaticSingleThreadedExecutor : public rclcpp::Executor
9999

100100
/// Static executor implementation of spin all
101101
/**
102-
* This function will execute entities until timeout or no more work available.
103-
* If timeout is equal to 0, it will block forever.
102+
* This non-blocking function will execute entities until timeout (must be >= 0)
103+
* or no more work available.
104104
* If new entities get ready while executing work available, they will be executed
105105
* as long as the timeout hasn't expired.
106106
*

0 commit comments

Comments
 (0)