From: James Britt <james_b@...>
Date: 2005-12-25T07:54:14+09:00
Subject: Re: Any reason 'Core API Docs' include non-core classes?

Gyoung-Yoon Noh wrote:
> Hi,
> 
> I have wondered why 'Core API Docs'[1] include non-core classes following:
> 
...
> 
> Any reason why those classes are included in 'Core API Docs'?

Coincidence?  The core  rdocs are the result of running rdoc over the 
main source dir.  There are few things in there that are not actually 
core libs, but get pulled into the rdoc anyway.

I would much prefer if all classes/modules were in the same rdoc space, 
with the docs for each file indicating what, if any, 'require' call is 
needed, but rdoc is fairly limited.

One should not have to know if a library is part of the core API or the 
standard library or some middle world in order to use the rdocs for the 
standard distro.

James

-- 

http://www.ruby-doc.org       - Ruby Help & Documentation
http://www.artima.com/rubycs/ - Ruby Code & Style: Writers wanted
http://www.rubystuff.com      - The Ruby Store for Ruby Stuff
http://www.jamesbritt.com     - Playing with Better Toys
http://www.30secondrule.com   - Building Better Tools