Method: Bundler::Thor.long_desc

Defined in:
lib/bundler/vendor/thor/lib/thor.rb

.long_desc(long_description, options = {}) ⇒ Object

Defines the long description of the next command.

Long description is by default indented, line-wrapped and repeated whitespace merged. In order to print long description verbatim, with indentation and spacing exactly as found in the code, use the wrap option

long_desc 'your very long description', wrap: false

Parameters

long description<String> options<Hash>



78
79
80
81
82
83
84
85
86
 
# File 'lib/bundler/vendor/thor/lib/thor.rb', line 78

def long_desc(long_description, options = {})
  if options[:for]
    command = find_and_refresh_command(options[:for])
    command.long_description = long_description if long_description
  else
    @long_desc = long_description
    @long_desc_wrap = options[:wrap] != false
  end
end