From: James Britt <james.britt@...>
Date: 2008-03-15T04:11:42+09:00
Subject: Re: How to Read Ruby API / Documentation :NUBY

7stud -- wrote:
> James Britt wrote:
>> 7stud -- wrote:
>>> You will have to get used to the fact that the Ruby docs are horrible.
>>
>> Patches welcome.
>>
>>
> 
> Open up the docs to user comments, and then they will be self 
> documenting.  See the php model.

Is that what stops you from contributing to the docs?  Or would you 
prefer that others make the contributions, while you simply declare them 
to be horrible?

There are some people who have taken the time to create and/or improve 
the docs.   You can bitch about their efforts, but a tangible 
contribution would be so much more durable.


(I apologize if you have been sending in doc patches.)

ruby-doc.org is currently running with Nitro; I'm inclined to port it to 
Ramaze.

If anyone is interested in helping me assemble a Ramaze-based means of 
allowing doc comments, with decent spam blocking, drop me a line.  (I 
prefer to use Og or Sequel for the ORM, but open to informed suggestions 
otherwise.)

Note that the API doc content would still need to be auto-generated from 
the svn ruby source and doing so should not interfere with any existing 
comments.


-- 
James Britt

"In physics the truth is rarely perfectly clear, and that is certainly
  universally the case in human affairs. Hence, what is not surrounded by
  uncertainty cannot be the truth."
  - R. Feynman