[Documentation] [TitleIndex] [WordIndex

rosparam/Reviews/2009-11 Doc Review_Doc_Review

Reviewer:

To review:

http://wiki/rosparam

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?
  2. Are all of these APIs documented?
  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?
  4. If there are hardware dependencies of the Package, are these documented?
  5. Is it clear to an outside user what the roadmap is for the Package?
  6. Is it clear to an outside user what the stability is for the Package?
  7. Are concepts introduced by the Package well illustrated?
  8. Is the research related to the Package referenced properly? i.e. can users easily get to relevant papers?
  9. Are any mathematical formulas in the Package not covered by papers properly documented?

Concerns / issues

Stu

Bhaskara

YAML dictionaries can occur as the argument to the load and set subcommands of rosparam. Dictionaries in this context are interpreted differently from dictionaries that are set as the value of a parameter (e.g., from a C++ node). In the first case, ...

Tim

Conclusion

Suggestions have been incorporated, marking as doc reviewed


2022-05-28 12:58