From: Ryan Davis <ryand-ruby@...>
Date: 2012-04-24T05:30:55+09:00
Subject: Re: To developers of Ruby: Feeble documentation - weakness of Ruby and the Ruby on Rails (2nd editio


On Apr 23, 2012, at 13:05 , Xavier Noria wrote:

> On Mon, Apr 23, 2012 at 9:17 PM, Ryan Davis <ryand-ruby@zenspider.com> wrote:
> 
> > Files:       144
> >
> > Classes:      82 ( 28 undocumented)
> > Modules:      90 ( 63 undocumented)
> > Constants:    21 ( 20 undocumented)
> > Attributes:   91 ( 84 undocumented)
> > Methods:     822 (385 undocumented)
> >
> > Total:      1106 (580 undocumented)
> >  47.56% documented
> 
> That's the oldest and most established subproject in rails... meaning, it has the least excuse to be less than 50% documented.
> 
> For some reason Gmail doesn't show me the origin of this thread. But that remark seems unfair to me.
> 
> For starters, that statistic presented like that, cold, is not very meaningful. You'd need to add how many of the undocumented methods are public interface. Because we are talking about end users, to which internal documentation is not a concern.

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%.