From: James Britt <jamesUNDERBARb@...>
Date: 2004-10-21T14:37:40+09:00
Subject: Re: eRuby for Windows

Gavin Kistner wrote:

> On Oct 13, 2004, at 9:31 AM, Bill Atkins wrote:
> 
>> http://www.ruby-doc.org/stdlib/libdoc/erb/rdoc/index.html
>>
>> On Wed, 13 Oct 2004 22:21:27 +0900, Gavin Kistner <gavin@refinery.com> 
>> wrote:
>>
>>> Except...erm...there's no documentation.
> 
> 
> Correct. That's the location where there's no documentation.
> (A page listing all methods and classes, without describing what they do 
> or now to use them, is not helpful.)

Mostly true.  A list of methods at least gives a place to start looking 
in the code, or some idea what might be possible.  But I get your basic 
point.  It is quite frustrating.

The API docs on ruby-doc come from the Ruby source code by way of RDoc.
Hence, if the author of a piece of code opted not to document the code 
using inline rdoc comments, and no one else has stepped up to take on 
the task, then no docs appear.

So, if anyone has docs for this, and cares to offer them to be placed in 
the source code, please speak up.  Or, if they are not really suitable 
to become part of the source, then can be hosted at ruby-doc as 
stand-alone documentation.


Thanks,


James