rxdeps/Reviews/2010-01-12_Doc_Review
Reviewer:
- kwc, tfield
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?
- Are all of these APIs documented?
- 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?
- Is it clear to an outside user what the roadmap is for the Package?
- Is it clear to an outside user what the stability is for the Package?
- Are concepts introduced by the Package well illustrated?
Concerns / issues
kwc: I added a note to make it clear that generates PDFs. Other than that, short and sweet.
tfield: might be nicer if the image were larger/intelligible, otherwise this looks fine. Bonus point for teaching me a new word: deduplicate.
Conclusion
Doc reviewed