square / fdoc

Documentation format and verification
Other
379 stars 59 forks source link

Refactor fdoc_to_html #26

Closed ohrite closed 11 years ago

ohrite commented 11 years ago

Most modern Ruby CLI apps use Thor to build out their frontend. Thor provides a lot of nice messaging and convenience for building a generator. Given that fdoc has a CLI and it's a generator, this seems like a great fit!

The important bits:

zachmargolis commented 11 years ago

Thanks for adding this!

This is an API-breaking change so we probably want to bump the minor version, add something to gem announce for deprecation, and then leave something in fdoc_to_html that proxies to the new one (also with a deprecation warning).

ohrite commented 11 years ago

Oh, good point! I'll add in a proxy now.

zachmargolis commented 11 years ago

Going to merge this, then add the deprecation warning, version bump myself. Thanks!