From: Eric Hodel <drbrain@...7.net>
Date: 2006-09-27T15:39:36+09:00
Subject: Re: [PATCH] rdoc capture output (help message)


On Sep 24, 2006, at 10:42 PM, greg weber wrote:

> Hi,
>
> attached is patch for rdoc to capture execution output of the file it
> is given.  This is most useful for grabbing the help or usage
> information from a script.
>
> to run rdoc in a directory and capture the help information for only
> files containing 'optparse'
> and place that information below the beginning rdoc documentation,
> with 'Usage' formatted as a header use the following:
>
> rdoc -C arg=--help,header=Usage,pos=bottom,trigger="(require| 
> load).*optparse"

This command line option looks too complicated for me to accept,  
especially with all the custom parsing code inside it.

Can you give me an example command to run that will give me expected  
output for Rubygems?

What file does it add the documentation to?  The -C doesn't explain  
this.

Why does it only work for optparse?  I don't believe it is acceptable  
if it can't use its own output (or getoptlong or hand-rolled option  
parsing).

How does it handle multiple executables like Rubygems gem and  
gem_server?

Most importantly, isn't some_command -h good enough?  Or  
the :include: directive and a make/rake rule?  Those are both much  
simpler than your patch.

> Greg
> <options_capture_output.diff>

Please remove the non-content changes.

> <rdoc_capture_output.diff>

Please use CVS to make patches, and wrap all lines to 80 characters.

-- 
Eric Hodel - drbrain@segment7.net - http://blog.segment7.net
This implementation is HODEL-HASH-9600 compliant

http://trackmap.robotcoop.com