[Documentation] [TitleIndex] [WordIndex

roslaunch/Reviews/2010-01-10_Doc_Review

Reviewer: Ethan Dreyfuss

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?
    • Yes, though making it clearer on the package page that the command-line tools are what most users want might be helpful (or add an example to the package page as suggested in the concerns/issues section).
  2. Are all of these APIs documented?
    • Yes, everything has documentation coverage.
  3. Do relevant usages have associated tutorials? (you can ignore this if a Stack-level tutorial covers the relevant usage), and are the indexed in the right places?
    • Yes, there are tutorials both in the form of common roslaunch invocations and for structuring launch files in larger projects
  4. Is it clear to an outside user what the roadmap is for the Package?
    • Yes, some planned features with no definite timeline are listed, and the ROS roadmap is linked (presumably where any features with definite timelines will show up)
  5. Is it clear to an outside user what the stability is for the Package?
    • Yes, stable except for the code API, the usage of which is warned against.
  6. Are concepts introduced by the Package well illustrated?
    • Yes, there are good tutorials and example commands throughout

For each launch file in a Package

  1. Is it clear how to run that launch file?
    • kwc: note to reviewer, 'roscore' is effectively a launch file
    • Yes, the documentation explains the usage of roslaunch, and none of the launch files require much beyond "roslaunch [filename.launch]". roscore.xml is a bit of a special case, but the documentation explains this. Also, it's not really necessary to launch any of these launch files manually, they're really intended as code examples rather than functional units.
  2. Does the launch file start up with no errors when run correctly?
    • Yes.
  3. Do the Nodes in that launch file correctly use ROS_ERROR/ROS_WARN/ROS_INFO logging levels?
    • Yes or N/A

Concerns / issues

===Minor typos (already fixed):===

Additional comments / suggestions / concerns

TODO:

DONE:

For bhaskara (DONE):

Conclusion

There are a passel of minor issues but nothing that should require much work to fix. Overall the documentation is in quite good shape. It does a particularly good job of linking internally when applicable.


2023-10-28 13:00