Skip to content

Commit 529b616

Browse files
committed
fix indentation and improve explanation of consequences
Signed-off-by: Alberto Soragna <[email protected]>
1 parent 04690a3 commit 529b616

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

rclcpp/include/rclcpp/executor.hpp

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -371,9 +371,9 @@ class Executor
371371
* If the time spent inside the blocking loop exceeds this timeout, return a TIMEOUT return
372372
* code.
373373
* \return The return code, one of `SUCCESS`, `INTERRUPTED`, or `TIMEOUT`.
374-
* \note This method will check the future and the timeout only when the executor is woke up.
375-
* If this future is unrelated to an executor's entity, this method will not detect correctly
376-
* when it's completed.
374+
* \note This method will check the future and the timeout only when the executor is woken up.
375+
* If this future is unrelated to an executor's entity, this method will not correctly detect
376+
* when it's completed and therefore may wait forever and never time out.
377377
*/
378378
template<typename FutureT, typename TimeRepT = int64_t, typename TimeT = std::milli>
379379
FutureReturnCode

0 commit comments

Comments
 (0)