Is the argument: option required when using multiple: true about cri

[roberts1000]

This is a great improvement and a big help! Thank you taking the time to improve the docs.

[denisdefreyne]

option’s argument: parameter defaults to :forbidden.

When an option has a forbidden argument, its value will end up being true. This is intended for flags such as --verbose:

flag :v, :verbose, 'be verbose'

# assuming the command is invoked with --verbose:

p options[:verbose]
# => true

When using multiple: true, all option values end up in an array. For options with required arguments, this means the array ends up containing a list of strings, while for options with forbidden arguments, the array ends up containing a list of trues:

flag :v, :verbose, 'be verbose', multiple: true

# assuming the command is invoked with --verbose --verbose --verbose:

p options[:verbose]
# => [true, true, true]

The documentation is admittedly unclear on :forbidden being the default, and on the array of trues. Will update.

[denisdefreyne]

Hi,

I’ve greatly expanded the section on how to define command-line options. It now has an explicit section on argument:, and also comes with a handful of examples. This should make it more understandable.

Let me know what you think!