Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mismatch between ROS wiki and code for ROS_[INFO/...]_..._THROTTLE C++ macros #1312

Closed
dmcconachie opened this issue Jan 24, 2018 · 1 comment

Comments

@dmcconachie
Copy link

dmcconachie commented Jan 24, 2018

The wiki entry (http://wiki.ros.org/roscpp/Overview/Logging) for the various THROTTLE rosconsole C++ macros does not match the code itself. The wiki states (correctly) that you provide a period, however the macros themselves use "rate".

...
#define ROS_INFO_THROTTLE(rate, ...) ROS_LOG_THROTTLE(rate, ::ros::console::levels::Info, ROSCONSOLE_DEFAULT_NAME, __VA_ARGS__)
#define ROS_INFO_STREAM_THROTTLE(rate, args) ROS_LOG_STREAM_THROTTLE(rate, ::ros::console::levels::Info, ROSCONSOLE_DEFAULT_NAME, args)
#define ROS_INFO_THROTTLE_NAMED(rate, name, ...) ROS_LOG_THROTTLE(rate, ::ros::console::levels::Info, std::string(ROSCONSOLE_NAME_PREFIX) + "." + name, __VA_ARGS__)
...

This has the potential for confusion if one uses the macro definition as a way of looking up what the macros do instead of going to the wiki.

This is obviously a low priority issue but if someone happens to be working in the area anyway, this could be cleaned up at the same time.

@dirk-thomas
Copy link
Member

period sounds indeed more accurate than rate. Please see #1318.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants