Class: Kafo::HelpBuilders::Basic

Inherits:
Base
  • Object
show all
Defined in:
lib/kafo/help_builders/basic.rb

Instance Method Summary collapse

Methods inherited from Base

#initialize

Methods included from StringHelper

#dashize, #parametrize, #underscore, #with_prefix

Constructor Details

This class inherits a constructor from Kafo::HelpBuilders::Base

Instance Method Details

#add_list(heading, items) ⇒ Object



13
14
15
16
# File 'lib/kafo/help_builders/basic.rb', line 13

def add_list(heading, items)
  pruned = except_advanced(items)
  super(heading, pruned)
end

#add_module(name, items) ⇒ Object



6
7
8
9
10
11
# File 'lib/kafo/help_builders/basic.rb', line 6

def add_module(name, items)
  pruned = except_resets(items)
  pruned = except_advanced(pruned)
  data = by_parameter_groups(pruned)
  add_list(module_header(name), data[DEFAULT_GROUP_NAME])
end

#stringObject



18
19
20
# File 'lib/kafo/help_builders/basic.rb', line 18

def string
  super + "\nOnly commonly used options have been displayed.\nUse --full-help to view the complete list."
end