From: Gavin Sinclair <gsinclair@...>
Date: 2002-11-05T07:48:11+09:00
Subject: Re: Stupid Newbie Question.

From: "Sean Armstrong" <sarmstrong@shearwatercorp.com>


> One different note:
> Is there a way to document and then read the documentation in the
> modules? For example, help in the python interactive reads off the
> module documentation and Perl has perldoc. Anything similar in Ruby?

The 'ri' command is an excellent command-line reference tool, like 'perldoc'
(though not as broad).  It contains documentation for all built-in classes.

There are people working on extending this to user modules and other things.

For library code, RDoc is like JavaDoc (if you know that), but better.  It
allows you to browse the classes and methods of the library, with comments
extracted from the code.  It's really good.

Gavin