module CommandKit::Examples::ClassMethods

Defines class-level methods.

Public Instance Methods

examples(new_examples=nil) click to toggle source

Gets or sets the example commands.

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

If a String or Array of Strings is given, it will set the class'es
example commands.

@return [Array<String>, nil]

The class'es or superclass'es example commands.

@example

examples [
  "-o output.txt path/to/file"
]

@api public

# File lib/command_kit/examples.rb, line 65
def examples(new_examples=nil)
  if new_examples
    @examples = Array(new_examples)
  else
    @examples || if superclass.kind_of?(ClassMethods)
                   superclass.examples
                 end
  end
end