123456789_123456789_123456789_123456789_123456789_

Class: IRB::Command::ShowDoc

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, Base
Instance Chain:
self, RubyArgsExtractor, Base
Inherits: IRB::Command::Base
Defined in: lib/irb/command/show_doc.rb

Class Method Summary

Base - Inherited

.category, .description, .execute, .help_message, .new, .highlight

Instance Attribute Summary

Base - Inherited

#irb_context

Instance Method Summary

RubyArgsExtractor - Included

#ruby_args, #unwrap_string_literal

Base - Inherited

#execute

Constructor Details

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

Instance Method Details

#execute(arg)

[ GitHub ] 

  


# 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