From: Suraj Kurapati <snk@...>
Date: 2008-01-08T09:14:08+09:00
Subject: Re: RDoc's TemplatePage Removed from Ruby

Eric Hodel wrote:
> I plan on making some further changes to the organization of the RDoc
> generation code, including documentation of what gets rendered when
> and what values are provided to the template.

One piece of information that's lacking from the current RDoc output is 
the name of the file in which a method is defined.

We have several odd cases in Ruby where the name of a class does not 
reflect the name of the file in which it is defined:  for example, Mutex 
and Queue are provided by the 'thread' file.

Also, there may be cases in the universe of Ruby libraries where a 
method is defined in a file different from the main definition of a 
class; in such cases, providing the name of the file in which a class is 
defined is insufficient.

Often times, I find a cool method when browsing the output of `ri` but I 
cannot figure out what file I need to require() in order to use the 
method.  For the sake of documentation, I request that this information 
is provided along with every method.

Thanks for your consideration.
-- 
Posted via http://www.ruby-forum.com/.