[Documentation] [TitleIndex] [WordIndex



Instructions for doing a doc review

See DocReviewProcess for more instructions

  1. Does the documentation define the Users of the Stack, i.e. for the expected usages of the Stack, which APIs will users engage with?
  2. Are all of these APIs documented?
  3. Do relevant usages have associated tutorials?
  4. Have all Packages in the Stack been API reviewed?

  5. Does the Stack conform to the StackDocumentation guidelines?

  6. Are there Packages in the Stack that don't belong

Concerns / issues


Everything looks good. I just calibrated a robot for the first time today based on these tutorials.

I made a small edit to explain the scatter plots, which we use for production testing, and made an edit to the auto-cal tutorial to bring it up to date.

I looked at the package documentation. Particularly in the pr2_calibration_estimation and the pr2_calibration_executive, Vijay has done a good job documenting and explaining the concepts behind the code. The illustrations are very clear.

If we want to make this stack more general, we'll have to decide on what code/ROS API's and functionality we want to support, if any.


Everything looks good to me. I like the heavy use of inkscape and the explanations are clear. Also, I've used the tutorial for calibrating the PR2 a number of times with success... so I'm happy to sign off on that. As Kevin pointed out, a lot of the APIs are unstable, but they're documented so that's fine. The only thing I noticed that should really be addressed is an open TODO at the bottom of the [pr2_calibration_executive] documentation. I'll take another quick pass in the morning, but I'm pretty sure this stuff is good to go.


2019-11-09 13:03