Skip to content

Minor suggestion for rclcpp::Node::now() documentation string #2688

@roncapat

Description

@roncapat

/// Returns current time from the time source specified by clock_type.
/**
* \sa rclcpp::Clock::now
*/
RCLCPP_PUBLIC
Time
now() const;

Notice how "clock_type" is never referenced in the node.hpp file.
I believe this is a copy-paste from rclcpp::Clock::now() method docstring.

Maybe it's better to say something like:

Returns current time from the node time source.
If `use_sim_time` parameter is set to `true` while
constructing the `Node`, the simulation time is returned,
otherwise system time is returned.

Metadata

Metadata

Assignees

Labels

bugSomething isn't working

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions