Improve documentation of wrapSite, runSnaplet and serveSnaplet #44

Merged
merged 2 commits into from Sep 20, 2012
Commits on Sep 20, 2012
  1. Improve documentation of wrapSite, runSnaplet and serveSnaplet

    ocharles committed Sep 20, 2012
    * wrapSite now clarifies that it wraps the base snaplet, not just the current
      snaplet.
    * runSnaplet now correctly shows the string "devel", instead of trying to link
      to the `devel` identifier.
    * serveSnaplet clearly documents both parameters, providing a hint that
      defaultConfig can be used. Also removed the FIXME comment.
  2. Improve documentation of wrapSite, runSnaplet and serveSnaplet

    ocharles committed Sep 20, 2012
    Mostly incoporating feedback from @gregorycollins on my original pull request. I
    have:
    
    * Simplified the documentation for `wrapSite` to be more direct, and removed a
      very contrived example.
    
    * Slightly amended the documentation for runSnaplet as it doesn't return a set
      of messages at all, but rather a single Text value.
    
    * Rewrote the documentation for serveSnaplet as requested.