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

--0015175cae18a2b17904be5eac5e
Content-Type: text/plain; charset=ISO-8859-1

On Mon, Apr 23, 2012 at 3:30 PM, Ryan Davis <ryand-ruby@zenspider.com>wrote:

> Wrong. Rdoc -C doesn't count anything marked with :nodoc: nor does it
> count methods that are private. So there is no reason why this number
> shouldn't be 100%.
>

How many of the un(der)documented classes/methods are actually useful to
end-users of the framework though? I'm not excusing the current state of
the documentation, but I'd hope the majority of what end users would
actually use is documented.

-- 
Tony Arcieri

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

<div class=3D"gmail_extra">On Mon, Apr 23, 2012 at 3:30 PM, Ryan Davis <spa=
n dir=3D"ltr">&lt;<a href=3D"mailto:ryand-ruby@zenspider.com" target=3D"_bl=
ank">ryand-ruby@zenspider.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:1p=
x #ccc solid;padding-left:1ex"><div class=3D"im">Wrong. Rdoc -C doesn&#39;t=
 count anything marked with :nodoc: nor does it count methods that are priv=
ate. So there is no reason why this number shouldn&#39;t be 100%.</div>


</blockquote></div><br>How many of the un(der)documented classes/methods ar=
e actually useful to end-users of the framework though? I&#39;m not excusin=
g the current state of the documentation, but I&#39;d hope the majority of =
what end users would actually use is documented.<br clear=3D"all">

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

--0015175cae18a2b17904be5eac5e--