Velocity Reviews - Computer Hardware Reviews

Velocity Reviews > Newsgroups > Programming > Ruby > RDoc::usage has gone

Reply
Thread Tools

RDoc::usage has gone

 
 
James Ponder
Guest
Posts: n/a
 
      04-01-2009
Hi

RDoc::usage was removed from ruby at the beginning of 2008, and thus is =
not present in Ruby 1.9.1:

Fri Jan 11 18:28:49 2008 Eric Hodel
* lib/rdoc/usage.rb: Removed.
* lib/getoptlong.rb: Update example to not use =
lib/rdoc/usage.rb.

It was a very useful function that allowed documentation in rdoc format =
to be programmatically output. I've been using it for displaying =
extended information either after an OptionsParser help summary output =
or as a replacement when OptionsParser's output isn't suitable. It's =
also very useful for other information-display reasons where you want =
information in rdoc format to also be programmatically available to =
avoid duplication.

It seems a shame that it has gone, especially as it is documented in the =
pickaxe book (second edition) and is widely deployed.

What is a suitable replacement?

James

 
Reply With Quote
 
 
 
 
Eric Hodel
Guest
Posts: n/a
 
      04-01-2009
On Apr 1, 2009, at 14:52, James Ponder wrote:
> RDoc::usage was removed from ruby at the beginning of 2008, and thus
> is not present in Ruby 1.9.1:
>
> Fri Jan 11 18:28:49 2008 Eric Hodel
> * lib/rdoc/usage.rb: Removed.
> * lib/getoptlong.rb: Update example to not use lib/rdoc/
> usage.rb.
>
> It was a very useful function that allowed documentation in rdoc
> format to be programmatically output. I've been using it for
> displaying extended information either after an OptionsParser help
> summary output or as a replacement when OptionsParser's output isn't
> suitable. It's also very useful for other information-display
> reasons where you want information in rdoc format to also be
> programmatically available to avoid duplication.
>
> It seems a shame that it has gone, especially as it is documented in
> the pickaxe book (second edition) and is widely deployed.
>
> What is a suitable replacement?


There's no reason you can't take rdoc/usage.rb from RDoc 1, modernize
it and release it as a gem.

 
Reply With Quote
 
 
 
Reply

Thread Tools

Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

BB code is On
Smilies are On
[IMG] code is On
HTML code is Off
Trackbacks are On
Pingbacks are On
Refbacks are Off


Similar Threads
Thread Thread Starter Forum Replies Last Post
where has my nerwork gone? pedd Wireless Networking 0 10-09-2004 01:58 AM
When they're gone, they could be gone for good... Richard DVD Video 10 06-02-2004 07:13 AM
Where has all my email gone? Mikey Computer Support 4 01-13-2004 08:17 AM
Re: Help needed with Internet Programs - OE has gone Ieuan Adams Computer Support 2 08-17-2003 09:30 PM
My "tab" button has gone crazy! Stephanie Computer Support 3 07-24-2003 03:15 PM



Advertisments