On Wednesday, October 8, 2003, at 01:06 AM, Gavin Sinclair wrote:
Simon Kitching wrote:
[snip]
I spent some time investigating the "shell" module in the ruby
standard
libs. I couldn't find any documentation at all on it, so went through
the source code, as extracted from CVS.
If there is documentation, can someone point me at it?
[snip]
If you wrote a magazine-style article which shows why you decided to
learn
about Shell, what it does for you, and what the reader needs to know
about
it in order to be productive, then we would arrange publication.
www.ruby-doc.org and www.learningruby.com are two good places for it to
rest. I (at least) would also provide detailed editorial feedback in
order to create a top-quality document.
I agree with Gavin that an article would be most helpful. I would also
be happy to help on the editorial feedback.
Some reference documentation is no doubt useful as well, and RDoc-ing
the
source will be good for that.
I would be happy to help with RDoc-ing the source. I made some efforts
a while ago, which I know can be improved on, that are on the
RubyGarden Wiki here:
http://www.rubygarden.org/ruby?ShellrbDocumentation
Let me know what I can do to help.
Regards,
Mark
|
