[Documentation] [TitleIndex] [WordIndex

pr2_hardware_interface/Reviews/2010-01-18_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?
    • kwc: yes, basically says do not touch
  2. Are all of these APIs documented?
    • kwc: yes, links to C++ api
  3. If there are hardware dependencies of the Package, are these documented?
    • kwc: yes, the PR2
  4. Is it clear to an outside user what the roadmap is for the Package?
    • kwc: no, but not applicable
  5. Is it clear to an outside user what the stability is for the Package?
    • kwc: no, but not applicable
  6. Are concepts introduced by the Package well illustrated?
    • kwc: no, but not applicable

Concerns / issues

Conclusion

kwc: from the documentation, pr2_hardware_interface appears to be an internal implementation detail. Users are directed to another package for the stable, proper API


2024-04-13 12:54