From: Tony Arcieri <tony.arcieri@...>
Date: 2012-04-24T05:20:28+09:00
Subject: Re: To developers of Ruby: Feeble documentation - weakness of Ruby and the Ruby on Rails (2nd editio

--00151747809e5c800b04be5e5e52
Content-Type: text/plain; charset=ISO-8859-1

On Mon, Apr 23, 2012 at 8:20 AM, Sergey Ezhov <lists@ruby-forum.com> wrote:

> http://api.rubyonrails.org/ - disgusting documentation! There are no
> descriptions of all classes, there are no descriptions of their
> correlations, there are no descriptions of many methods, there are no
> descriptions of parameters of these methods.


You might try http://apidock.com. It's the same information, but I prefer
the interface.

That said, there are 1100 classes in Rails. A list of each of them and what
they do isn't going to be particularly helpful, since there are very few
you actually need to use as an end user of the framework.

Correlations between classes are definitely documented, although as always
the documentation could be better. See the documentation for ActiveRecord,
for example:

http://apidock.com/rails/ActiveRecord/Base

-- 
Tony Arcieri

--00151747809e5c800b04be5e5e52
Content-Type: text/html; charset=ISO-8859-1
Content-Transfer-Encoding: quoted-printable

<div class=3D"gmail_extra">On Mon, Apr 23, 2012 at 8:20 AM, Sergey Ezhov <s=
pan dir=3D"ltr">&lt;<a href=3D"mailto:lists@ruby-forum.com" target=3D"_blan=
k">lists@ruby-forum.com</a>&gt;</span> wrote:<br><div class=3D"gmail_quote"=
><blockquote class=3D"gmail_quote" style=3D"margin:0 0 0 .8ex;border-left:1=
px #ccc solid;padding-left:1ex">

<a href=3D"http://api.rubyonrails.org/" target=3D"_blank">http://api.rubyon=
rails.org/</a> - disgusting documentation! There are no<br>
descriptions of all classes, there are no descriptions of their<br>
correlations, there are no descriptions of many methods, there are no<br>
descriptions of parameters of these methods.</blockquote><div><br></div><di=
v>You might try <a href=3D"http://apidock.com">http://apidock.com</a>. It&#=
39;s the same information, but I prefer the interface.</div><div><br></div>

<div>That said, there are 1100 classes in Rails. A list of each of them and=
 what they do isn&#39;t going to be particularly helpful, since there are v=
ery few you actually need to use as an end user of the framework.</div>

<div><br></div><div>Correlations between classes are definitely documented,=
 although as always the documentation could be better. See the documentatio=
n for ActiveRecord, for example:</div><div>=A0</div><div><a href=3D"http://=
apidock.com/rails/ActiveRecord/Base">http://apidock.com/rails/ActiveRecord/=
Base</a></div>

<div><br></div></div>-- <br>Tony Arcieri<br><br>
</div>

--00151747809e5c800b04be5e5e52--