geometry/Reviews/2011-07 Eigen Unary_Doc_Review


  • Ken
  • Ethan
  • Wim

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

/!\ Wim: should we continue to host eigen page in future?

  • Ken: yes, but it will just be a plain page eventually. Eigen is very pervasive so it is nice to have additional docs.

/!\ Ethan: 'common issues' looks like a Cookbook.

  • -> moved to 'cookbook' page.

/!\ Ethan: red is a little distracting

/!\ Wim: should we remove the stack header?

/!\ Wim: needs guide on using FindEigen.cmake

/!\ Ken: does it make sense to still link to ros-pkg trac?

(X) Ethan: missing rosdep porting guide (stack/package depend)


  • Added Cmake example
  • Created cookbook page
  • Removed StackHeader macro, just a plain old page

  • Removed bug tracker link

Wiki: geometry/Reviews/2011-07 Eigen Unary_Doc_Review (last edited 2011-07-14 19:07:24 by ethanrublee)