method

class_option

Importance_2
v2_6_3 - Show latest stable - 0 notes - Class: ClassMethods
  • 1_8_6_287
  • 1_8_7_72
  • 1_8_7_330
  • 1_9_1_378
  • 1_9_2_180
  • 1_9_3_125
  • 1_9_3_392
  • 2_1_10
  • 2_2_9
  • 2_4_6
  • 2_5_5
  • 2_6_3 (0)
  • What's this?
class_option(name, options = {}) public

Adds an option to the set of class options

Parameters

name

The name of the argument.

options

Described below.

Options

:desc

– Description for the argument.

:required

– If the argument is required or not.

:default

Default value for this argument.

:group

– The group for this options. Use by class options to output options in different levels.

:aliases

– Aliases for this option. Note: Bundler::Thor follows a convention of one-dash-one-letter options. Thus aliases like “-something” wouldn’t be parsed; use either “--something” or “-s” instead.

:type

– The type of the argument, can be :string, :hash, :array, :numeric or :boolean.

:banner

String to show on usage notes.

:hide

– If you want to hide this option from the help.

Show source
Register or log in to add new notes.