Module: October::Plugin::Help

Defined in:
lib/october/plugin/help.rb

Constant Summary collapse

@@help = 
{}

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.extended(base) ⇒ Object 



6
7
 
# File 'lib/october/plugin/help.rb', line 6

def self.extended(base)
end

Instance Method Details

#list_help ⇒ Object 



13
14
15
16
17
 
# File 'lib/october/plugin/help.rb', line 13

def list_help
  @@help.map do |command, description|
    ["  !", [command, description].compact.join(' - ')].join
  end.join("\n")
end

#register_help(command, description = nil) ⇒ Object 



9
10
11
 
# File 'lib/october/plugin/help.rb', line 9

def register_help command, description = nil
  @@help[command] = description
end