On Wed, Apr 26, 2006 at 08:22:26AM -0700, Justin Bailey wrote:
>    I think part of the problem is the docs on api.rubyonrails.org don't
>    include the whole Rails codebase. For example, the entire Rails
>    "namespace" is excluded. The source files have comments and I imagine
>    those can be published via RDoc - is there any reason to hide them?

As I see it, the reason to "hide" the internal api, from at least the main
api documentation, is that there are far more people interested in working
*with* Rails than there are people interested in working *on* Rails. For that
80 plus percent, having all the internal api docs mixed in with the external
facing api would just be a huge jungle to sift through with a high noise
ratio. 

There could be some value, indeed, in having a separate place one could go to
get full documentation, including the internal api, but I don't think it's a
good fit for the main api docs.

marcel
-- 
Marcel Molina Jr. <[EMAIL PROTECTED]>
_______________________________________________
Rails-core mailing list
Rails-core@lists.rubyonrails.org
http://lists.rubyonrails.org/mailman/listinfo/rails-core

Reply via email to