module CommandKit::Description::ClassMethods

Defines class-level methods.

Public Instance Methods

description(new_description=nil) click to toggle source

Gets or sets the description string.

@param [String, nil] new_description

If a String is given, the class'es description will be set.

@return [String, nil]

The class'es or superclass'es description.

@example

description "Does things and stuff"

@api public

# File lib/command_kit/description.rb, line 58
def description(new_description=nil)
  if new_description
    @description = new_description
  else
    @description || if superclass.kind_of?(ClassMethods)
                      superclass.description
                    end
  end
end