From: Dave Thomas <dave@...>
Date: 2003-12-12T07:16:30+09:00
Subject: Re: Ruby Doc Vision (was Re: Docs for Socket, OpenSSL, etc)


On Dec 11, 2003, at 15:57, Gavin Sinclair wrote:

> Excellent.  I don't know why Dave's new work on RDoc means you
> shouldn't continue with Socket and OpenSSL, but since it's in C it
> could be a curly one.

Because I may need to extend RDoc's markup slightly to help it get more 
information out of the C source. At the moment there's no way of giving 
meaningful names to method parameters, for example.

The timeline is first to get RDoc and ri integrated, and then to add 
RDoc comments to one of the built-in classes (perhaps Array) and to see 
what issues come up. Once I've worked the the majority of the problems, 
I'll then release it and ask for help, initially integrating the 
existing ri documentation into the standard core Ruby files. Once 
that's done, we can turn our attention to the libraries.

Cheers

Dave