Velocity Reviews - Computer Hardware Reviews

Velocity Reviews > Newsgroups > Programming > Ruby > IHelp 0.3.2 - View the documentation for an object

Reply
Thread Tools

IHelp 0.3.2 - View the documentation for an object

 
 
Ilmari Heikkinen
Guest
Posts: n/a
 
      11-13-2006
IHelp lets you view the ri documentation of an object from Ruby.
Perfect for irb.

sudo gem install ihelp

Downloads: http://rubyforge.org/frs/?group_id=2597
Documentation: http://ihelp.rubyforge.org
Project page: http://rubyforge.org/projects/ihelp/


CHANGES

Now with Ruby 1.8.5 compatability fixes and an emacs renderer from rubikitch.


QUICK USAGE

"Hmm, how did String#center work again?"
> String.help:center


"What is this object and what can i do with it?"
> object.help


"Someone told me that I should look up Mutex#synchronize...
but I don't have that loaded."
> help "Mutex#synchronize"



LOADING AUTOMATICALLY IN IRB

Add the following to your .irbrc:

# Loading RI may take a second or two so let's make it
# snappier by loading in the background.
Thread.new do require 'ihelp' end

## Renderer to use, one of 'ri', 'rubydoc', 'emacs', 'source', 'html'
## default is 'ri'
# IHelp.renderer = 'rubydoc'

## Web browser to use with renderers 'rubydoc' and 'html'
## default is 'firefox'
# IHelp.web_browser = 'konqueror'

 
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
IHelp: a bugreport and an extension (mocked-up repost) Cs. Henk Ruby 2 03-04-2005 03:16 AM
IHelp bugreport and extension Csaba Henk Ruby 1 03-02-2005 05:54 PM
[ANN] IHelp 0.3.0 Ilmari Heikkinen Ruby 5 02-27-2005 02:39 AM
[ANN] IHelp 0.3.1 Ilmari Heikkinen Ruby 0 02-27-2005 12:47 AM
[ANN] IHelp 0.2.0 Ilmari Heikkinen Ruby 10 01-23-2005 10:40 PM



Advertisments