Skip to content

Commit 8e441ca

Browse files
authored
Update docstring for rclcpp::Node::now()
Signed-off-by: Patrick Roncagliolo <[email protected]>
1 parent d724536 commit 8e441ca

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

rclcpp/include/rclcpp/node.hpp

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1430,8 +1430,11 @@ class Node : public std::enable_shared_from_this<Node>
14301430
rclcpp::Clock::ConstSharedPtr
14311431
get_clock() const;
14321432

1433-
/// Returns current time from the time source specified by clock_type.
1433+
/// Returns current time from the node time source.
14341434
/**
1435+
* If `use_sim_time` parameter is set to `true` the simulation time is returned,
1436+
* otherwise system time is returned.
1437+
14351438
* \sa rclcpp::Clock::now
14361439
*/
14371440
RCLCPP_PUBLIC

0 commit comments

Comments
 (0)