Ruby equivalent to Python's help()?

user_183355 0
Viewed 6744

When working in interactive Python, I tend to rely on the built-in help() function to tell me what something expects and/or returns, and print out any documentation that might help me. Is there a Ruby equivalent to this function?

I'm looking for something I could use in irb. For example, in interactive Python I could type:

>>> help(1)

which would then print

Help on int object:

class int(object)  |  int(x[, base])
-> integer  |    |  

Convert a string or number to an integer, if possible. A ...
ruby python
5 Answers

It's definitely a poor cousin to iPython's help, and one of the main features I miss after moving to Ruby, but you can also use ri from within irb. I'd recommend the wirble gem as an easy way to set this up.

user_1572370

Try using ri from the command line.

It takes a class name, method, or module as an argument, and gives you appropriate documentation. Many popular gems come with this form of documentation, as well, so it should typically work even beyond the scope of core Ruby modules.

user_1074150

There's supposed to be irb_help. But like mentioned in that post, it's broken in my ruby install as well.

user_163630
Related