summaryrefslogtreecommitdiff
path: root/lib/irb/cmd/help.rb
blob: 64b885c3835a45794cd5608850a95dd9d012aeba (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
# frozen_string_literal: true

require_relative "show_doc"

module IRB
  module ExtendCommand
    class Help < ShowDoc
      category "Context"
      description "[DEPRECATED] Enter the mode to look up RI documents."

      DEPRECATION_MESSAGE = <<~MSG
        [Deprecation] The `help` command will be repurposed to display command help in the future.
        For RI document lookup, please use the `show_doc` command instead.
        For command help, please use `show_cmds` for now.
      MSG

      def execute(*names)
        warn DEPRECATION_MESSAGE
        super
      end
    end
  end
end