image_transport/Reviews/10-05-2009_Doc_Review

Reviewer: Caroline Pantofaru

Instructions for doing a doc review

See DocReviewProcess for more instructions

1. Does the documentation define the Users of your Package, i.e. for the expected usages of your Stack, which APIs will users engage with?
   • The "republish" node info needs to be bumped higher or made into a tutorial. The most basic use of this package is to compress an image stream using the "republish" node. Right now, users don't even notice that the node exists (demonstrated in a usability test).
2. Are all of these APIs documented?
   • Yes
3. Do relevant usages have associated tutorials? (you can ignore this if a Stack-level tutorial covers the relevant usage), and are they indexed in the right places?
   • See the first comment about "republish".
4. Is it clear to an outside user what the roadmap is for the Package?

   • I think so, although a flow chart might be nice. raw_image_stream --> republish --> raw+compressed image streams, etc.

5. Is it clear to an outside user what the stability is for the Package? No?

For each launch file in a Package

1. Is it clear how to run that launch file?
   • There are no launch files. Perhaps an example launch file, at least for the "republish" node, would be nice.

Concerns / issues

• Please write up something for Python users. They should know that image_transport doesn't work in Python, but that they can still subscribe to the raw image transport.

Conclusions

The documentation looks very nice. Thanks for writing so many tutorials!