From: Roger Pack <rogerpack2005@...>
Date: 2009-02-13T02:48:38+09:00
Subject: Re: docstrings


> Since docstrings, like rdoc comments have to appear in the source code, 
> I
> don't understand how they help documenting code which is dynamically
> generated when the program is run.
> 
> In my current project, I recently switched over from dynamicly defined
> methods to a rake task to generate some of the source code in order to 
> have
> the resulting methods documented with RDOC/RI.

I do like the current ri style, and it does 90% of what I'm asking for.

So the question is what benefit is gained with dynamic documentation 
over ri style comments?

The two goals I'd have are 1) quick lookup from irb
Ex:
Currently ruby does not have a
method.desc
command.

and also documentation for dynamically generated methods.  As you noted 
above, it requires extra work.  Rails, for example, cannot enumerate all 
its possible dynamic methods.

Is there a way in rdoc to describe dynamically generated methods?

The first goal is the most important, now that I think about it.

I could create a gem which include "irb fastri" lookup [1].

Am I missing anything?
-=r
[1] http://eigenclass.org/hiki/irb+ri+completion
-- 
Posted via http://www.ruby-forum.com/.