From: "Keith P. Boruff" <kboruff@...>
Date: 2005-01-22T08:10:57+09:00
Subject: Re: Documentation standard

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.
> Additional Java APIs are easy to find and the API docs always look the
> same, which makes it very easy to get started with a new API. In Ruby
> new APIs are harder to find and it's always the question if there is
> any documentation and what it will look like.

All other things about Java aside, it does provide some good documentation.

But Ruby's is getting better. I'm in the same boat as you (learning 
Ruby) and am finding this site: http://www.ruby-doc.org useful.

Also, I actually bought the most updated Pragmatic Programmer's book 
instead of viewing the free online first edition. It has a few more 
things in it from what I can see.

BTW, I think it's fun too. It's a nice diversion from the "uppity C++" 
stuff that I usually do.

KPB