Skip to content

Commit

Permalink
[ruby/optparse] [DOC] Add missing secition
Browse files Browse the repository at this point in the history
  • Loading branch information
nobu authored and hsbt committed Dec 25, 2023
1 parent df941aa commit af4e839
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 0 deletions.
9 changes: 9 additions & 0 deletions doc/optparse/ruby/argument_abbreviation.rb
@@ -0,0 +1,9 @@
require 'optparse'
parser = OptionParser.new
parser.on('-x', '--xxx=VALUE', %w[ABC def], 'Argument abbreviations') do |value|
p ['--xxx', value]
end
parser.on('-y', '--yyy=VALUE', {"abc"=>"XYZ", def: "FOO"}, 'Argument abbreviations') do |value|
p ['--yyy', value]
end
parser.parse!
23 changes: 23 additions & 0 deletions doc/optparse/tutorial.rdoc
Expand Up @@ -351,6 +351,29 @@ Executions:

Omitting an optional argument does not raise an error.

==== Argument Abbreviations

Specify an argument list as an Array or a Hash.

:include: ruby/argument_abbreviation.rb

When an argument is abbreviated, the expanded argument yielded.

Executions:

$ ruby argument_abbreviation.rb --help
Usage: argument_abbreviation [options]
Usage: argument_abbreviation [options]
-x, --xxx=VALUE Argument abbreviations
-y, --yyy=VALUE Argument abbreviations
$ ruby argument_abbreviation.rb --xxx A
["--xxx", "ABC"]
$ ruby argument_abbreviation.rb --xxx c
argument_abbreviation.rb:9:in `<main>': invalid argument: --xxx c (OptionParser::InvalidArgument)
$ ruby argument_abbreviation.rb --yyy a --yyy d
["--yyy", "XYZ"]
["--yyy", "FOO"]

=== Argument Values

Permissible argument values may be restricted
Expand Down

0 comments on commit af4e839

Please sign in to comment.