koenbok/Framer — pull request #18 by arbales (2013-04-08 20:26:15+00:00)
Title: [RFC] Some documentation

*Request for comments…*

I spent some time this weekend reading and documenting `utils.coffee` —

* I also noticed a few places that implementations of these methods vary quite a bit from ES5 / Underscore / LowDash's implementations (see: `utils#filter`, `utils#copy`, and `utils#union`)

* I started with TomDoc, as its a personal favorite and feels nice with CoffeeScript, but I'd be in favor of any documentation format you prefer.

* I updated the names of some arguments for simplicity (like `execAsap` in `utils#throttle`) and consistency (prefer `fn` over `func` universally)

**If** this is something you think would be valuable, I'd enjoy documenting the remainder of Framer as well.