[Documentation] [TitleIndex] [WordIndex

roswtf/Reviews/2009-12-30_Doc_Review

Reviewers:

API Review

Tully: Please also do an API review of the plugin API.

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. Is it clear to an outside user what the roadmap is for the Package?
  5. Is it clear to an outside user what the stability is for the Package?
  6. Are concepts introduced by the Package well illustrated?

Concerns / issues

Kevin

Usage

Plugins

Other docs

Tully

Usage

Plugin API

    for r in rospack_warnings:
        warning_rule(r, r[0](ctx), ctx)
    for r in rospack_errors:
        error_rule(r, r[0](ctx), ctx)

Conclusion

TODO:

Based on above comments, roswtf end user API is doc reviewed. More work remains to be done for plugin API. As plugin API is still very advanced and not well exercised, leaving that for a later date.

→ status=Doc reviewed, notes=end-user docs passed. plugin API requires more work.


2020-02-22 13:11