Class: Command::Optional

Inherits:

ArgumentDecoration

• Object
• Argument
• ArgumentDecoration
• Command::Optional

Defined in:

lib/command-set/arguments.rb

Overview

Most common decorator. Tags a argument as omitable. Otherwise, the interpreter will return an error to the user if they leave out an argument. Optional arguments that aren’t provided are set to nil.

Instance Attribute Summary

Attributes inherited from Argument

#name

Instance Method Summary

• #required? ⇒ Boolean

Methods inherited from ArgumentDecoration

#decorated, #initialize, #pretty_print_instance_variables, register

Methods inherited from Argument

#basis, #check_present, #complete, #consume, #consume_hash, #initialize, #match_terms, #names, #omittable?, #parse, register, #subject_requirements, #validate

Constructor Details

This class inherits a constructor from Command::ArgumentDecoration

Instance Method Details

#required? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/command-set/arguments.rb', line 425

def required?
  false
end