[Documentation] [TitleIndex] [WordIndex

navfn/Reviews/2009-10-06 Doc Review

Reviewer:

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 perhaps making this a little more explicit in the package documentation would help.
  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 the indexed in the right places?
    • No tutorials beyond those for the navigation system as a whole, but that is OK. The end user is not expected to need to interact with NavFN or NavFNRos directly.
  4. If there are hardware dependencies of the Package, are these documented?
    • N/A
  5. Is it clear to an outside user what the roadmap is for the Package?
    • Stack level roadmap is OK, only think I might like to see as a user in a package roadmap is navFN cleanup / debugging of A*.
  6. Is it clear to an outside user what the stability is for the Package?
    • Yes, it is clearly listed in a section for each package component.
  7. Are concepts introduced by the Package well illustrated?
    • The costmap computation would make for a pretty picture, but full documentation for NavFN is probably where this should go, and that is a project for the future. Otherwise I don't think any illustrations are required.
  8. Is the research related to the Package referenced properly? i.e. can users easily get to relevant papers?
    • I don't think there is anything that needs to go here, perhaps in NavFN documentation when it exists.
  9. Are any mathematical formulas in the Package not covered by papers properly documented?
    • N/A for NavFNROS, NavFN is not being documented at the moment

For each launch file in a Package

  1. Is it clear how to run that launch file?
  2. Does the launch file start up with no errors when run correctly?
  3. Do the Nodes in that launch file correctly use ROS_ERROR/ROS_WARN/ROS_INFO logging levels?

Concerns / issues

Minor edits:

Conclusion

Things are looking much better. There are a few minor cleanup issues, but nothing that should take very long.


2023-10-28 12:49