New in Whois: Goodbye RDoc, Welcome Yardoc

YARD is a documentation generation tool for the Ruby programming language. It is a very powerful alternative to RDoc, actively developed and maintained by Loren Segal.

YARD allows you to use Markdown or Textile to write your documentations, provides structured tags to better describe your methods and has a very advanced parsing mechanism. It also under active development, which is a very good sign of interest.

Back in September I asked for feedback about using Yardoc over Rdoc and YARD won with full consensus.

I'm now proud to say that the master branch of the Whois library is now entirely documented with YARD. It took several weeks, but I'm really satisfied with the result. I also had the chance to fix several documentation errors an increase documentation coverage.

The result of Yardoc for Whois README

The Yardoc documentation will eventually replace the current Whois RDoc documentation. I'm sure that it will be an awesome integration to the existing Whois manual.

In the meantime, you can try it yourself by downloading the library from Github and using the YARD server, an other awesome YARD feature.

$ gem install yard
$ git clone
$ cd whois
$ yard server --reload

The result of Yardoc for Whois::Answer

I already converted the Public Suffix Service API documentation to YARD a few weeks ago.