ros2 / rmw

The ROS Middleware (rmw) Interface.
Apache License 2.0
95 stars 67 forks source link

Inconsistent documentation with code #321

Closed IIIIIIIIll closed 2 years ago

IIIIIIIIll commented 2 years ago

Bug report

Required Info:

Steps to reproduce issue

https://github.com/ros2/rmw/blob/6d23f9fc6bfe4616e1efeeefee7a927635a83afe/rmw/include/rmw/get_node_info_and_types.h#L140-L177

Expected behavior

Consistent documentation with funciton signature.

Actual behavior

Inconsistent documentation with funciton signature.

Additional information

Function contains a boolean value demangle in its signature, but the documentation names the same value no_demangle. It is pretty confusing what the actual behavior should be when this value is set to true.

christophebedard commented 2 years ago

This was fixed right after Foxy in https://github.com/ros2/rmw/pull/250, which should clear it up: it should be no_demangle.

clalancette commented 2 years ago

Good call. I think we can backport that change too, as it won't break ABI; it is only changing the header file. I'll do that right now.

IIIIIIIIll commented 2 years ago

Thank you for the clarification!

christophebedard commented 2 years ago

I think this can be closed.

clalancette commented 2 years ago

Closing with #322