Class: IRB::Command::ShowDoc

Inherits:
Base show all
Includes:
RubyArgsExtractor
Defined in:
lib/irb/command/show_doc.rb

Instance Attribute Summary

Attributes inherited from Base

#irb_context

Instance Method Summary collapse

Methods included from RubyArgsExtractor

#ruby_args, #unwrap_string_literal

Methods inherited from Base

category, description, execute, help_message, #initialize

Constructor Details

This class inherits a constructor from IRB::Command::Base

Instance Method Details

#execute(arg) ⇒ Object 



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/irb/command/show_doc.rb', line 25

def execute(arg)
  # Accept string literal for backward compatibility
  name = unwrap_string_literal(arg)
  require 'rdoc/ri/driver'

  unless ShowDoc.const_defined?(:Ri)
    opts = RDoc::RI::Driver.process_args([])
    ShowDoc.const_set(:Ri, RDoc::RI::Driver.new(opts))
  end

  if name.nil?
    Ri.interactive
  else
    begin
      Ri.display_name(name)
    rescue RDoc::RI::Error
      puts $!.message
    end
  end

  nil
rescue LoadError, SystemExit
  warn "Can't display document because `rdoc` is not installed."
end