Reading documents in irb

One thing I missed about ipython does she have? An operator that splits documents for a specific function.

I know that ruby ​​has a similar command line tool, but it is very inconvenient to call it while I am in irb.

Does ruby ​​/ irb have something like this?

+5
source share
3 answers

Pry is a Ruby version of IPython, it supports a command ?to find documentation on methods, but uses a slightly different syntax:

pry(main)> ? File.dirname

From: file.c in Ruby Core (C Method):
Number of lines: 6

visibility:  public
signature:  dirname()

Returns all components of the filename given in file_name
except the last one. The filename must be formed using forward
slashes (/'') regardless of the separator used on the
local file system.

   File.dirname("/home/gumby/work/ruby.rb")   #=> "/home/gumby/work"

You can also find the source code using the command $:

pry(main)> $ File.link

From: file.c in Ruby Core (C Method):
Number of lines: 14

static VALUE
rb_file_s_link(VALUE klass, VALUE from, VALUE to)
{
    rb_secure(2);
    FilePathValue(from);
    FilePathValue(to);
    from = rb_str_encode_ospath(from);
    to = rb_str_encode_ospath(to);

    if (link(StringValueCStr(from), StringValueCStr(to)) < 0) {
    sys_fail2(from, to);
    }
    return INT2FIX(0);
}

See http://pry.github.com for more details :)

+6

irb(main):001:0> `ri Object`

, . .

, -

gem install ori

irb

irb(main):001:0> require 'ori'
=> true
irb(main):002:0> Object.ri
Looking up topics [Object] o
= Object < BasicObject

------------------------------------------------------------------------------
= Includes:
Java (from gem activesupport-3.0.9)

(from gem activesupport-3.0.9) [...]
+5

No, it is not. Python has docstrings:

def my_method(arg1,arg2):
  """ What inside this string will be made available as the __doc__ attribute """
  # some code

So, when ?called from ipython, it probably calls the attribute of the __doc__object. Ruby does not have this.

+3
source

All Articles