From: Zach Dennis <zdennis@...>
Date: 2005-01-22T12:21:32+09:00
Subject: Re: Documentation standard

James Britt wrote:
> cyberco wrote:
> 
>> Hello!
>>
>> I just got started with Ruby after years of Java and I'm having a lot
>> of fun with it! Especially with the pragmatic programmer's book by my
>> side.
>>
>> There's one thing that reduces the fun I have: the way Ruby libraries
>> are documented. Even the documentation of the standard and the core
>> APIs are below par if you ask me. That's one thing the Ruby community
>> can learn from the Java community: how to do proper documentation.

On a side note, I am in the process of writing a java-api like generator 
  for rdoc for wxRuby, because the wxRuby folks don't care much for 
default rdoc style browsing... i'll keep the list posted the farther i 
get, i just started yesterday.

so maybe this will ease some pain, just by how the information is 
displayed to the user

Zach