diagnostics icon indicating copy to clipboard operation
diagnostics copied to clipboard

On Foxy throws exception using diagnostic_aggregator tutorial

Open anderwm opened this issue 5 years ago • 2 comments

Not sure if the tutorial(https://wiki.ros.org/diagnostics/Tutorials/Configuring%20Diagnostic%20Aggregators) just needs updating or if the code could do some smart casting, but...

Specifically the 'contains' field must be a list of strings now now contains: ['whatever'] instead of contains: 'whatever. Also crashes if timeout is an int instead of double.

anderwm avatar Jan 04 '21 17:01 anderwm

Thanks for reporting this issue!

The tutorial indeed needs an update for ROS 2. @Karsten1987 do you have an idea how to go forward with this or any common practice how you handled this with other packages? Should be split the tutorial in a ROS 1 and ROS 2 version? Or should we mark the existing tutorial as 'ROS 1 only' and add a ROS 2 tutorial at a different place later?

@anderwm Until this is sorted out, you may want to have a look at the foxy diagnostic aggregator example.

norro avatar Jan 11 '21 08:01 norro

I generally prefer to have the documentation close to the code. That is, have the tutorial be placed in a README.rst or similar in the same repo. That allows to adapt quickly to differences between branches etc. In this particular case, I'd say we write an appropriate tutorial for the ROS2 version of diagnostics and pack it in a readme. Once it's released, this readme should show up on index.ros.org to which we could link a note from ros.wiki.org indicating that the documentation for ROS2 can be found there.

Opinions?

Karsten1987 avatar Jan 11 '21 19:01 Karsten1987

Closing this since foxy is EOL. If this occurs in a newer release, please reopen.

ct2034 avatar Jun 12 '23 07:06 ct2034