module CommandKit::Description

Allows adding a description to a command's class.

## Examples

include CommandKit::Description

description "Does things and stuff"

Public Instance Methods

description() click to toggle source

@see ClassMethods#description

@api semipublic

# File lib/command_kit/description.rb, line 74
def description
  self.class.description
end
help() click to toggle source

Calls the superclass'es `#help` method, if it's defined, then calls {#help_description}.

@api public

Calls superclass method CommandKit::Help#help
# File lib/command_kit/description.rb, line 96
def help
  super

  help_description
end
help_description() click to toggle source

Prints the {ClassMethods#description description}, if set.

@api semipublic

# File lib/command_kit/description.rb, line 83
def help_description
  if (description = self.description)
    puts
    puts description
  end
end