More Ruby: Did some RDoc

In the area of learning more Ruby and teaching others about its greatness, I did some uncovering yesterday:

Shortly: RDoc is amazing.

The :include: _somefile_ statement is a powerful way of keeping your README and your code rather separate. If that is what you want, then you can put the long, descriptive story about your code in a separate file, and use the interspersed API docs comments for documenting the parts of it.

(This post was written at the website, and sent to the Morningstar blog using some XMLRPC. If it works, it is quite fancy.)

Published by olleolleolle

Olle is a programmer, enjoying sunny Malmö in Sweden.

Leave a comment

Your email address will not be published. Required fields are marked *

This site uses Akismet to reduce spam. Learn how your comment data is processed.