Rename banner to help_message

ruby · Feb 17, 2024 · 3170d26 · 3170d26
1 parent 90eb545
commit 3170d26
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 8 deletions.
diff --git a/lib/irb/command/base.rb b/lib/irb/command/base.rb
@@ -22,9 +22,9 @@ def description(description = nil)
           @description
         end
 
-        def banner(banner = nil)
-          @banner = banner if banner
-          @banner
+        def help_message(help_message = nil)
+          @help_message = help_message if help_message
+          @help_message
         end
 
         private

diff --git a/lib/irb/command/edit.rb b/lib/irb/command/edit.rb
@@ -9,7 +9,7 @@ module Command
     class Edit < Base
       category "Misc"
       description 'Open a file or source location.'
-      banner <<~BANNER
+      help_message <<~HELP_MESSAGE
         Usage: edit [FILE or constant or method signature]
 
         Open a file in the editor specified in #{highlight('ENV["VISUAL"]')} or #{highlight('ENV["EDITOR"]')}
@@ -24,7 +24,7 @@ class Edit < Base
           edit foo.rb
           edit Foo
           edit Foo#bar
-      BANNER
+      HELP_MESSAGE
 
       class << self
         def transform_args(args)

diff --git a/lib/irb/command/help.rb b/lib/irb/command/help.rb
@@ -21,7 +21,7 @@ def execute(command_name = nil)
         content =
           if command_name
             if command_class = ExtendCommandBundle.load_command(command_name)
-              command_class.banner || command_class.description
+              command_class.help_message || command_class.description
             else
               "Can't find command `#{command_name}`. Please check the command name and try again.\n\n"
             end

diff --git a/lib/irb/command/ls.rb b/lib/irb/command/ls.rb
@@ -14,11 +14,11 @@ class Ls < Base
       category "Context"
       description "Show methods, constants, and variables."
 
-      banner <<~BANNER
+      help_message <<~HELP_MESSAGE
         Usage: ls [obj] [-g [query]]
 
           -g [query]  Filter the output with a query.
-      BANNER
+      HELP_MESSAGE
 
       def self.transform_args(args)
         if match = args&.match(/\A(?<args>.+\s|)(-g|-G)\s+(?<grep>[^\s]+)\s*\n\z/)