Class: Benry::CmdApp::BaseHelpBuilder

Inherits:
Object
  • Object
show all
Defined in:
lib/benry/cmdapp.rb

Direct Known Subclasses

ActionHelpBuilder, ApplicationHelpBuilder

Constant Summary collapse

HEADER_USAGE =
"Usage:"
HEADER_DESCRIPTION =
"Description:"
HEADER_OPTIONS =
"Options:"
HEADER_ACTIONS =
"Actions:"
HEADER_ALIASES =
"Aliases:"
HEADER_ABBREVS =
"Abbreviations:"
HEADER_CATEGORIES =
"Categories:"

Instance Method Summary collapse

Constructor Details

#initialize(config, _registry: REGISTRY) ⇒ BaseHelpBuilder

Returns a new instance of BaseHelpBuilder.



1256
1257
1258
1259
# File 'lib/benry/cmdapp.rb', line 1256

def initialize(config, _registry: REGISTRY)
  @config    = config
  @_registry = _registry
end

Instance Method Details

#build_help_message(x, all: false) ⇒ Object

Raises:

  • (NotImplementedError)


1269
1270
1271
1272
# File 'lib/benry/cmdapp.rb', line 1269

def build_help_message(x, all: false)
  #; [!0hy81] this is an abstract method.
  raise NotImplementedError.new("#{self.class.name}#build_help_message(): not implemented yet.")
end