module CommandKit::Usage::ClassMethods

Class-level methods.

Public Instance Methods

usage(new_usage=nil) click to toggle source

Gets or sets the class'es usage string(s).

@param [String, Array<String>, nil] new_usage

If a new_usage argument is given, it will set the class'es usage
string(s).

@return [String, Array<String>]

The class'es or superclass'es usage string(s).

@example

usage "[options] ARG1 ARG2 [ARG3 ...]"

@api public

# File lib/command_kit/usage.rb, line 61
def usage(new_usage=nil)
  if new_usage
    @usage = new_usage
  else
    @usage || (superclass.usage if superclass.kind_of?(ClassMethods))
  end
end