Module: Amp::Help

Defined in:
lib/amp-front/help/help.rb,
lib/amp-front.rb

Overview

The module covering all the help subsystems for the Amp binary.

Defined Under Namespace

Modules: HelpRegistry, HelpUI Classes: CommandHelpEntry, ErbHelpEntry, HelpEntry, MarkdownHelpEntry

Class Method Summary collapse

Class Method Details

.load_default_entriesObject

A method that loads in the default entries for the help system. Normally, I’d just put this code in the module itself, or perhaps at the end of the file, but I’m experimenting with an approach where I try to minimize the bare code, leaving only the invocation of this method to sit in the module.



303
304
305
306
307
# File 'lib/amp-front/help/help.rb', line 303

def self.load_default_entries
  Dir[File.join(File.dirname(__FILE__), "entries", "**")].each do |file|
    HelpEntry.from_file(file)
  end
end