Re: stdlib-doc rake enhancements

James Britt <[email protected]> Thu, 24 Aug 2006 16:31:09 -0700
Newsgroups gmane.comp.lang.ruby.documentation
Organization ruby-doc.org
Message-ID <[email protected]>
Mat Schaffer wrote:
> On the point that was brought up earlier, would it be worth while to  
> give stdlib-doc's Rakefile the necessary tasks to check out a copy of  
> ruby?  I may spend some time on this in the coming days, but I  thought 
> I'd open it up for comment first.


I was thinking (in an idle sort of way) that a set of rdoc'ing Rake 
tasks might:

* Checkout or update the proper CVS source code
* Generate the correct diffs for new/altered code comments
* Generate a simple E-mail that could be posted to the ruby-doc list
* Send such mail.   Maybe.

The CVS checkout and diffing seem like really good candidates to 
automated tasks.  Stubbing out an E-mail message could be handy, too, as 
it could (if done right) help ensure that the message has some minimally 
important details.  But I don't know that quite how that would work 
beyond looking for diff files someplace and divining the source file names.

It might be nice (i.e., someone else does the work) if as part of the 
stdlib-doc gem a project generator scrip was installed.  The script 
would create a base directory and some subdirs, and set up the Rakefile 
with tasks for getting the correct source code and doing the proper diffs.

So one could do

$ gem install stdlib-doc
$ doco <some-dir-name>

and the doco script sets up a nice project area for doing doc stuff.


Or something.


James