mojombo/tomdoc — Issue #32: Add direct support for option hashes
Author: dasch
Created: 2011-11-11 09:23:08+00:00
State: open

A *lot* of Ruby method use options hashes as the primary way to pass arguments. Having an easy and intuitive way to document these is extremely important if TomDoc is to be usable, at least for me.

How about:

```ruby
# Options
#
# count - The Integer number of times to duplicate the text.
# account - The Account used for bamboodling.
# user - The User responsible that has to answer to the RIAA.
```