roscreate/Reviews/2010-01-07_Doc_Review
Reviewer:
- Nate
Instructions for doing a doc review
See DocReviewProcess for more instructions
- 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
- Are all of these APIs documented?
- Yes
- 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?
- Yes
- Is it clear to an outside user what the roadmap is for the Package?
- Yes
- Is it clear to an outside user what the stability is for the Package?
- Yes
- Are concepts introduced by the Package well illustrated?
- Yes
Concerns / issues
The documentation for roscreate-pkg should probably mention that the path in which you run the command matters. The other ros tools need the newly created package to exist in an existing package path.
- kwc: FIXED
Conclusion
Doc reviewed