class CLI::Formatter
- CLI::Formatter
- Reference
- Object
Overview
Generates a formatted help template for command components.
Defined in:
cli/formatter.crConstructors
Instance Method Summary
-
#format_arguments : String
Returns a formatted string for arguments in the set command.
-
#format_commands : String
Returns a formatted string for subcommands (children) of the set command.
-
#format_options : String
Returns a formatted string for options in the set command.
-
#generate : String
Generates a help template for the set command.
Constructor Detail
Instance Method Detail
def format_commands : String
#
Returns a formatted string for subcommands (children) of the set command.
def generate : String
#
Generates a help template for the set command. This will attempt to fill fields that have not been set in the command, for example, command usage strings.