Ruby DocTest

→ ‘rubydoctest’

What

Ruby DocTest is a tool that lets you put irb-style tests in your documentation. It’s similar to Python’s doctest, but different in several ways.

Installing

sudo gem install rubydoctest

Wiki, Documentation, Examples

See the github wiki

How to submit patches

Read the 8 steps for fixing other people’s code.

The git repository is http://github.com/tablatom/rubydoctest/tree/master for anonymous access.

Build and test instructions

cd rubydoctest
rake test:doctest
rake install_gem

License

This code is free to use under the terms of the MIT license.

Contact

Comments are welcome. Send an email to Duane Johnson.

Duane Johnson, 23rd June 2008
Theme extended from Paul Battley