Module: Commander::HelpFormatter

### Home Classes Methods

### In Files

- lib/commander/help_formatters.rb
- lib/commander/help_formatters/base.rb
- lib/commander/help_formatters/terminal.rb
- lib/commander/help_formatters/terminal_compact.rb

### Namespace

- CLASS Commander::HelpFormatter::Base
- CLASS Commander::HelpFormatter::Terminal
- CLASS Commander::HelpFormatter::TerminalCompact

### Methods

- #indent

### Class/Module Index

Quicksearch

- Commander
- Commander::Command
- Commander::Command::Options
- Commander::Delegates
- Commander::HelpFormatter
- Commander::HelpFormatter::Base
- Commander::HelpFormatter::Terminal
- Commander::HelpFormatter::TerminalCompact
- Commander::Platform
- Commander::Runner
- Commander::Runner::CommandError
- Commander::Runner::InvalidCommandError
- Commander::UI
- Commander::UI::AskForClass
- Commander::UI::ProgressBar
- Array
- Blank
- Object

No matching classes.

# Commander::HelpFormatter

# Help Formatter

Commander's help formatters control the output when either the help command, or --help switch are called. The default formatter is Commander::HelpFormatter::Terminal.

### Public Instance Methods

indent(amount, text) click to toggle source

    # File lib/commander/help_formatters.rb, line 9
    def indent amount, text
      text.gsub("\n", "\n" + (' ' * amount))
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.