ros2_control icon indicating copy to clipboard operation
ros2_control copied to clipboard

Review & update controller_interface documentation on realtime-safe methods

Open bmagyar opened this issue 4 years ago • 4 comments

Methods that should be realtime-safe should have this documented in their docstrings

bmagyar avatar May 15 '21 07:05 bmagyar

What would you like to see, would something like //this method should be realtime-safe in the header be good enough?

dignakov avatar May 30 '21 20:05 dignakov

Yeah!

bmagyar avatar Jun 02 '21 15:06 bmagyar

I think we should also add a "This method is non-realtime-safe" where appropriate to be explicit. Otherwise, no comment would be ambiguous between "Not yet documented" and "Non-RT-safe"

I think the ros(1)_control codebase does it that way, though I believe the coverage isn't 100%

matthew-reynolds avatar Jun 02 '21 16:06 matthew-reynolds