Improve documentation of wrapSite, runSnaplet and serveSnaplet

snapframework / snap

Top-level package for the official Snap Framework libraries, includes the snaplets API as well as infrastructure for sessions, auth, and templates.

http://snapframework.com/

BSD 3-Clause "New" or "Revised" License

455 stars 68 forks source link

Improve documentation of wrapSite, runSnaplet and serveSnaplet #44

Closed ocharles closed 12 years ago

ocharles commented 12 years ago

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.

ocharles commented 12 years ago

Ok, see the details of the above commit for my latest changes. I havent't changed that indentation because at least this is consistent with the file (and @mightybyte disagreed too, so maybe this should be agreed on and changed en masse).