Contents

# frozen_string_literal: true

module IRB
  module Command
    class ShowDoc < Base
      include RubyArgsExtractor

      category "Context"
      description "Look up documentation with RI."

      help_message <<~HELP_MESSAGE
        Usage: show_doc [name]

        When name is provided, IRB will look up the documentation for the given name.
        When no name is provided, a RI session will be started.

        Examples:

          show_doc
          show_doc Array
          show_doc Array#each

      HELP_MESSAGE

      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
    end
  end
end

Version data entries

9 entries across 9 versions & 3 rubygems

Version	Path
minato_ruby_api_client-0.2.2	vendor/bundle/ruby/3.2.0/gems/irb-1.14.0/lib/irb/command/show_doc.rb
irb-1.14.3	lib/irb/command/show_doc.rb
irb-1.14.2	lib/irb/command/show_doc.rb
irb-1.14.1	lib/irb/command/show_doc.rb
blacklight-spotlight-3.6.0.beta8	vendor/bundle/ruby/3.2.0/gems/irb-1.13.2/lib/irb/command/show_doc.rb
irb-1.14.0	lib/irb/command/show_doc.rb
irb-1.13.2	lib/irb/command/show_doc.rb
irb-1.13.1	lib/irb/command/show_doc.rb
irb-1.13.0	lib/irb/command/show_doc.rb