Skip to content

Commit 464d5d9

Browse files
committed
Fix documentation
Signed-off-by: Michael X. Grey <[email protected]>
1 parent f77d593 commit 464d5d9

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

rclrs/src/timer.rs

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -196,8 +196,9 @@ impl Timer {
196196
Ok(())
197197
}
198198

199-
/// Creates a new timer. Users should call [`Node::create_timer`] or
200-
/// [`Node::create_timer_oneshot`].
199+
/// Creates a new timer. Users should call one of [`Node::create_timer`],
200+
/// [`Node::create_timer_repeating`], [`Node::create_timer_oneshot`], or
201+
/// [`Node::create_timer_inert`].
201202
pub(crate) fn new(
202203
context: &ContextHandle,
203204
period: Duration,
@@ -286,7 +287,7 @@ impl Timer {
286287
}
287288

288289
/// Updates the state of the rcl_timer to know that it has been called. This
289-
/// should only be called by [`Self::execute`].
290+
/// should only be called by [`Self::call`].
290291
///
291292
/// The callback held by the rcl_timer is null because we store the callback
292293
/// in the [`Timer`] struct. This means there are no side-effects to this
@@ -530,7 +531,7 @@ mod tests {
530531
));
531532

532533
// The unwrap will panic if anything went wrong with the call
533-
timer.rcl_call().unwrap();
534+
timer.call().unwrap();
534535

535536
// The unwrap will panic if the remaining time is negative
536537
timer.time_until_next_call().unwrap();

0 commit comments

Comments
 (0)