dvyjones/defender — Issue #12: YARD or TomDoc
Author: dvyjones
Created: 2011-11-29 14:33:46+00:00
State: open

Not to long ago I switched the documentation from YARD to TomDoc. However, I'm not sure whether to keep TomDoc or switch back to YARD.

I think TomDoc looks nice for in-code documentation, and when working on Defender , in-code documentation is nice (that way I don't have to switch around between windows).

However, if you use Defender in your app, I imagine things like [RubyDoc.info](http://rubydoc.info/github/dvyjones/defender/master/frames) is nicer, and TomDoc doesn't work well with that.

So, what do you think? Keep TomDoc or switch back to YARD?