1berry/ruby
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[ruby/optparse] [DOC] Update documents to use single quotes instead of backqoutes

Browse Source 
https://github.com/ruby/optparse/commit/5e71a70cb5
This commit is contained in:
Nobuyoshi Nakada 2025-03-10 14:05:16 +09:00 committed by git
parent 1a985d36a7
commit 9de9cb53c0
4 changed files with 34 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/optparse/argument_converters.rdoc
View File

@ -377,4 +377,4 @@ Executions:
$ ruby match_converter.rb --capitalize foo $ ruby match_converter.rb --capitalize foo
["Foo", String] ["Foo", String]
$ ruby match_converter.rb --capitalize "foo bar" $ ruby match_converter.rb --capitalize "foo bar"
match_converter.rb:9:in `<main>': invalid argument: --capitalize foo bar (OptionParser::InvalidArgument) match_converter.rb:9:in '<main>': invalid argument: --capitalize foo bar (OptionParser::InvalidArgument)

29
doc/optparse/option_params.rdoc
View File

@ -91,7 +91,7 @@ Executions:
Usage: short_required [options] Usage: short_required [options]
-xXXX Short name with required argument -xXXX Short name with required argument
$ ruby short_required.rb -x $ ruby short_required.rb -x
short_required.rb:6:in `<main>': missing argument: -x (OptionParser::MissingArgument) short_required.rb:6:in '<main>': missing argument: -x (OptionParser::MissingArgument)
$ ruby short_required.rb -x FOO $ ruby short_required.rb -x FOO
["-x", "FOO"] ["-x", "FOO"]
@ -181,7 +181,7 @@ Executions:
Usage: long_required [options] Usage: long_required [options]
--xxx XXX Long name with required argument --xxx XXX Long name with required argument
$ ruby long_required.rb --xxx $ ruby long_required.rb --xxx
long_required.rb:6:in `<main>': missing argument: --xxx (OptionParser::MissingArgument) long_required.rb:6:in '<main>': missing argument: --xxx (OptionParser::MissingArgument)
$ ruby long_required.rb --xxx FOO $ ruby long_required.rb --xxx FOO
["--xxx", "FOO"] ["--xxx", "FOO"]
@ -243,11 +243,11 @@ Usage: mixed_names [options]
$ ruby mixed_names.rb --xxx $ ruby mixed_names.rb --xxx
["--xxx", true] ["--xxx", true]
$ ruby mixed_names.rb -y $ ruby mixed_names.rb -y
mixed_names.rb:12:in `<main>': missing argument: -y (OptionParser::MissingArgument) mixed_names.rb:12:in '<main>': missing argument: -y (OptionParser::MissingArgument)
$ ruby mixed_names.rb -y FOO $ ruby mixed_names.rb -y FOO
["--yyy", "FOO"] ["--yyy", "FOO"]
$ ruby mixed_names.rb --yyy $ ruby mixed_names.rb --yyy
mixed_names.rb:12:in `<main>': missing argument: --yyy (OptionParser::MissingArgument) mixed_names.rb:12:in '<main>': missing argument: --yyy (OptionParser::MissingArgument)
$ ruby mixed_names.rb --yyy BAR $ ruby mixed_names.rb --yyy BAR
["--yyy", "BAR"] ["--yyy", "BAR"]
$ ruby mixed_names.rb -z $ ruby mixed_names.rb -z
@ -279,7 +279,7 @@ Executions:
Usage: argument_keywords [options] Usage: argument_keywords [options]
-x, --xxx Required argument -x, --xxx Required argument
$ ruby argument_styles.rb --xxx $ ruby argument_styles.rb --xxx
argument_styles.rb:6:in `<main>': missing argument: --xxx (OptionParser::MissingArgument) argument_styles.rb:6:in '<main>': missing argument: --xxx (OptionParser::MissingArgument)
$ ruby argument_styles.rb --xxx FOO $ ruby argument_styles.rb --xxx FOO
["--xxx", "FOO"] ["--xxx", "FOO"]
@ -298,7 +298,7 @@ Executions:
Usage: argument_strings [options] Usage: argument_strings [options]
-x, --xxx=XXX Required argument -x, --xxx=XXX Required argument
$ ruby argument_strings.rb --xxx $ ruby argument_strings.rb --xxx
argument_strings.rb:9:in `<main>': missing argument: --xxx (OptionParser::MissingArgument) argument_strings.rb:9:in '<main>': missing argument: --xxx (OptionParser::MissingArgument)
$ ruby argument_strings.rb --xxx FOO $ ruby argument_strings.rb --xxx FOO
["--xxx", "FOO"] ["--xxx", "FOO"]
@ -331,7 +331,7 @@ Executions:
-xXXX Values for required argument -xXXX Values for required argument
-y [YYY] Values for optional argument -y [YYY] Values for optional argument
$ ruby explicit_array_values.rb -x $ ruby explicit_array_values.rb -x
explicit_array_values.rb:9:in `<main>': missing argument: -x (OptionParser::MissingArgument) explicit_array_values.rb:9:in '<main>': missing argument: -x (OptionParser::MissingArgument)
$ ruby explicit_array_values.rb -x foo $ ruby explicit_array_values.rb -x foo
["-x", "foo"] ["-x", "foo"]
$ ruby explicit_array_values.rb -x f $ ruby explicit_array_values.rb -x f
@ -339,9 +339,9 @@ Executions:
$ ruby explicit_array_values.rb -x bar $ ruby explicit_array_values.rb -x bar
["-x", "bar"] ["-x", "bar"]
$ ruby explicit_array_values.rb -y ba $ ruby explicit_array_values.rb -y ba
explicit_array_values.rb:9:in `<main>': ambiguous argument: -y ba (OptionParser::AmbiguousArgument) explicit_array_values.rb:9:in '<main>': ambiguous argument: -y ba (OptionParser::AmbiguousArgument)
$ ruby explicit_array_values.rb -x baz $ ruby explicit_array_values.rb -x baz
explicit_array_values.rb:9:in `<main>': invalid argument: -x baz (OptionParser::InvalidArgument) explicit_array_values.rb:9:in '<main>': invalid argument: -x baz (OptionParser::InvalidArgument)
===== Explicit Values in Hash ===== Explicit Values in Hash
@ -361,7 +361,7 @@ Executions:
-xXXX Values for required argument -xXXX Values for required argument
-y [YYY] Values for optional argument -y [YYY] Values for optional argument
$ ruby explicit_hash_values.rb -x $ ruby explicit_hash_values.rb -x
explicit_hash_values.rb:9:in `<main>': missing argument: -x (OptionParser::MissingArgument) explicit_hash_values.rb:9:in '<main>': missing argument: -x (OptionParser::MissingArgument)
$ ruby explicit_hash_values.rb -x foo $ ruby explicit_hash_values.rb -x foo
["-x", 0] ["-x", 0]
$ ruby explicit_hash_values.rb -x f $ ruby explicit_hash_values.rb -x f
@ -369,7 +369,7 @@ Executions:
$ ruby explicit_hash_values.rb -x bar $ ruby explicit_hash_values.rb -x bar
["-x", 1] ["-x", 1]
$ ruby explicit_hash_values.rb -x baz $ ruby explicit_hash_values.rb -x baz
explicit_hash_values.rb:9:in `<main>': invalid argument: -x baz (OptionParser::InvalidArgument) explicit_hash_values.rb:9:in '<main>': invalid argument: -x baz (OptionParser::InvalidArgument)
$ ruby explicit_hash_values.rb -y $ ruby explicit_hash_values.rb -y
["-y", nil] ["-y", nil]
$ ruby explicit_hash_values.rb -y baz $ ruby explicit_hash_values.rb -y baz
@ -377,14 +377,15 @@ Executions:
$ ruby explicit_hash_values.rb -y bat $ ruby explicit_hash_values.rb -y bat
["-y", 3] ["-y", 3]
$ ruby explicit_hash_values.rb -y ba $ ruby explicit_hash_values.rb -y ba
explicit_hash_values.rb:9:in `<main>': ambiguous argument: -y ba (OptionParser::AmbiguousArgument) explicit_hash_values.rb:9:in '<main>': ambiguous argument: -y ba (OptionParser::AmbiguousArgument)
$ ruby explicit_hash_values.rb -y bam $ ruby explicit_hash_values.rb -y bam
["-y", nil] ["-y", nil]
==== Argument Value Patterns ==== Argument Value Patterns
You can restrict permissible argument values You can restrict permissible argument values
by specifying a Regexp that the given argument must match. by specifying a +Regexp+ that the given argument must match,
or a +Range+ or +Array+ that the converted value must be included in.
File +matched_values.rb+ defines options with matched argument values. File +matched_values.rb+ defines options with matched argument values.
@ -400,7 +401,7 @@ Executions:
$ ruby matched_values.rb --xxx FOO $ ruby matched_values.rb --xxx FOO
["--xxx", "FOO"] ["--xxx", "FOO"]
$ ruby matched_values.rb --xxx bar $ ruby matched_values.rb --xxx bar
matched_values.rb:6:in `<main>': invalid argument: --xxx bar (OptionParser::InvalidArgument) matched_values.rb:6:in '<main>': invalid argument: --xxx bar (OptionParser::InvalidArgument)
=== Argument Converters === Argument Converters

32
doc/optparse/tutorial.rdoc
View File

@ -111,7 +111,7 @@ Executions:
["x", true] ["x", true]
["input_file.txt", "output_file.txt"] ["input_file.txt", "output_file.txt"]
$ ruby basic.rb -a $ ruby basic.rb -a
basic.rb:16:in `<main>': invalid option: -a (OptionParser::InvalidOption) basic.rb:16:in '<main>': invalid option: -a (OptionParser::InvalidOption)
=== Defining Options === Defining Options
@ -232,11 +232,11 @@ Executions:
$ ruby mixed_names.rb --xxx $ ruby mixed_names.rb --xxx
["--xxx", true] ["--xxx", true]
$ ruby mixed_names.rb -y $ ruby mixed_names.rb -y
mixed_names.rb:12:in `<main>': missing argument: -y (OptionParser::MissingArgument) mixed_names.rb:12:in '<main>': missing argument: -y (OptionParser::MissingArgument)
$ ruby mixed_names.rb -y FOO $ ruby mixed_names.rb -y FOO
["--yyy", "FOO"] ["--yyy", "FOO"]
$ ruby mixed_names.rb --yyy $ ruby mixed_names.rb --yyy
mixed_names.rb:12:in `<main>': missing argument: --yyy (OptionParser::MissingArgument) mixed_names.rb:12:in '<main>': missing argument: --yyy (OptionParser::MissingArgument)
$ ruby mixed_names.rb --yyy BAR $ ruby mixed_names.rb --yyy BAR
["--yyy", "BAR"] ["--yyy", "BAR"]
$ ruby mixed_names.rb -z $ ruby mixed_names.rb -z
@ -270,9 +270,9 @@ Executions:
$ ruby name_abbrev.rb --draft $ ruby name_abbrev.rb --draft
["--draft", true] ["--draft", true]
$ ruby name_abbrev.rb --d $ ruby name_abbrev.rb --d
name_abbrev.rb:9:in `<main>': ambiguous option: --d (OptionParser::AmbiguousOption) name_abbrev.rb:9:in '<main>': ambiguous option: --d (OptionParser::AmbiguousOption)
$ ruby name_abbrev.rb --dr $ ruby name_abbrev.rb --dr
name_abbrev.rb:9:in `<main>': ambiguous option: --dr (OptionParser::AmbiguousOption) name_abbrev.rb:9:in '<main>': ambiguous option: --dr (OptionParser::AmbiguousOption)
$ ruby name_abbrev.rb --dry $ ruby name_abbrev.rb --dry
["--dry-run", true] ["--dry-run", true]
$ ruby name_abbrev.rb --dra $ ruby name_abbrev.rb --dra
@ -285,7 +285,7 @@ You can disable abbreviation using method +require_exact+.
Executions: Executions:
$ ruby no_abbreviation.rb --dry-ru $ ruby no_abbreviation.rb --dry-ru
no_abbreviation.rb:10:in `<main>': invalid option: --dry-ru (OptionParser::InvalidOption) no_abbreviation.rb:10:in '<main>': invalid option: --dry-ru (OptionParser::InvalidOption)
$ ruby no_abbreviation.rb --dry-run $ ruby no_abbreviation.rb --dry-run
["--dry-run", true] ["--dry-run", true]
@ -323,7 +323,7 @@ Executions:
Omitting a required argument raises an error: Omitting a required argument raises an error:
$ ruby required_argument.rb -x $ ruby required_argument.rb -x
required_argument.rb:9:in `<main>': missing argument: -x (OptionParser::MissingArgument) required_argument.rb:9:in '<main>': missing argument: -x (OptionParser::MissingArgument)
==== Option with Optional Argument ==== Option with Optional Argument
@ -369,7 +369,7 @@ Executions:
$ ruby argument_abbreviation.rb --xxx A $ ruby argument_abbreviation.rb --xxx A
["--xxx", "ABC"] ["--xxx", "ABC"]
$ ruby argument_abbreviation.rb --xxx c $ ruby argument_abbreviation.rb --xxx c
argument_abbreviation.rb:9:in `<main>': invalid argument: --xxx c (OptionParser::InvalidArgument) argument_abbreviation.rb:9:in '<main>': invalid argument: --xxx c (OptionParser::InvalidArgument)
$ ruby argument_abbreviation.rb --yyy a --yyy d $ ruby argument_abbreviation.rb --yyy a --yyy d
["--yyy", "XYZ"] ["--yyy", "XYZ"]
["--yyy", "FOO"] ["--yyy", "FOO"]
@ -403,7 +403,7 @@ Executions:
-xXXX Values for required argument -xXXX Values for required argument
-y [YYY] Values for optional argument -y [YYY] Values for optional argument
$ ruby explicit_array_values.rb -x $ ruby explicit_array_values.rb -x
explicit_array_values.rb:9:in `<main>': missing argument: -x (OptionParser::MissingArgument) explicit_array_values.rb:9:in '<main>': missing argument: -x (OptionParser::MissingArgument)
$ ruby explicit_array_values.rb -x foo $ ruby explicit_array_values.rb -x foo
["-x", "foo"] ["-x", "foo"]
$ ruby explicit_array_values.rb -x f $ ruby explicit_array_values.rb -x f
@ -411,9 +411,9 @@ Executions:
$ ruby explicit_array_values.rb -x bar $ ruby explicit_array_values.rb -x bar
["-x", "bar"] ["-x", "bar"]
$ ruby explicit_array_values.rb -y ba $ ruby explicit_array_values.rb -y ba
explicit_array_values.rb:9:in `<main>': ambiguous argument: -y ba (OptionParser::AmbiguousArgument) explicit_array_values.rb:9:in '<main>': ambiguous argument: -y ba (OptionParser::AmbiguousArgument)
$ ruby explicit_array_values.rb -x baz $ ruby explicit_array_values.rb -x baz
explicit_array_values.rb:9:in `<main>': invalid argument: -x baz (OptionParser::InvalidArgument) explicit_array_values.rb:9:in '<main>': invalid argument: -x baz (OptionParser::InvalidArgument)
===== Explicit Values in Hash ===== Explicit Values in Hash
@ -433,7 +433,7 @@ Executions:
-xXXX Values for required argument -xXXX Values for required argument
-y [YYY] Values for optional argument -y [YYY] Values for optional argument
$ ruby explicit_hash_values.rb -x $ ruby explicit_hash_values.rb -x
explicit_hash_values.rb:9:in `<main>': missing argument: -x (OptionParser::MissingArgument) explicit_hash_values.rb:9:in '<main>': missing argument: -x (OptionParser::MissingArgument)
$ ruby explicit_hash_values.rb -x foo $ ruby explicit_hash_values.rb -x foo
["-x", 0] ["-x", 0]
$ ruby explicit_hash_values.rb -x f $ ruby explicit_hash_values.rb -x f
@ -441,7 +441,7 @@ Executions:
$ ruby explicit_hash_values.rb -x bar $ ruby explicit_hash_values.rb -x bar
["-x", 1] ["-x", 1]
$ ruby explicit_hash_values.rb -x baz $ ruby explicit_hash_values.rb -x baz
explicit_hash_values.rb:9:in `<main>': invalid argument: -x baz (OptionParser::InvalidArgument) explicit_hash_values.rb:9:in '<main>': invalid argument: -x baz (OptionParser::InvalidArgument)
$ ruby explicit_hash_values.rb -y $ ruby explicit_hash_values.rb -y
["-y", nil] ["-y", nil]
$ ruby explicit_hash_values.rb -y baz $ ruby explicit_hash_values.rb -y baz
@ -449,7 +449,7 @@ Executions:
$ ruby explicit_hash_values.rb -y bat $ ruby explicit_hash_values.rb -y bat
["-y", 3] ["-y", 3]
$ ruby explicit_hash_values.rb -y ba $ ruby explicit_hash_values.rb -y ba
explicit_hash_values.rb:9:in `<main>': ambiguous argument: -y ba (OptionParser::AmbiguousArgument) explicit_hash_values.rb:9:in '<main>': ambiguous argument: -y ba (OptionParser::AmbiguousArgument)
$ ruby explicit_hash_values.rb -y bam $ ruby explicit_hash_values.rb -y bam
["-y", nil] ["-y", nil]
@ -472,7 +472,7 @@ Executions:
$ ruby matched_values.rb --xxx FOO $ ruby matched_values.rb --xxx FOO
["--xxx", "FOO"] ["--xxx", "FOO"]
$ ruby matched_values.rb --xxx bar $ ruby matched_values.rb --xxx bar
matched_values.rb:6:in `<main>': invalid argument: --xxx bar (OptionParser::InvalidArgument) matched_values.rb:6:in '<main>': invalid argument: --xxx bar (OptionParser::InvalidArgument)
=== Keyword Argument +into+ === Keyword Argument +into+
@ -524,7 +524,7 @@ Executions:
-y, --yyyYYY Short and long, required argument -y, --yyyYYY Short and long, required argument
-z, --zzz [ZZZ] Short and long, optional argument -z, --zzz [ZZZ] Short and long, optional argument
$ ruby missing_options.rb --yyy FOO $ ruby missing_options.rb --yyy FOO
missing_options.rb:11:in `<main>': Missing required options: [:xxx, :zzz] (RuntimeError) missing_options.rb:11:in '<main>': Missing required options: [:xxx, :zzz] (RuntimeError)
==== Default Values for Options ==== Default Values for Options

4
lib/optparse.rb
View File

@ -142,7 +142,7 @@
# Used: # Used:
# #
# $ ruby optparse-test.rb -r # $ ruby optparse-test.rb -r
# optparse-test.rb:9:in `<main>': missing argument: -r (OptionParser::MissingArgument) # optparse-test.rb:9:in '<main>': missing argument: -r (OptionParser::MissingArgument)
# $ ruby optparse-test.rb -r my-library # $ ruby optparse-test.rb -r my-library
# You required my-library! # You required my-library!
# #
@ -235,7 +235,7 @@
# $ ruby optparse-test.rb --user 2 # $ ruby optparse-test.rb --user 2
# #<struct User id=2, name="Gandalf"> # #<struct User id=2, name="Gandalf">
# $ ruby optparse-test.rb --user 3 # $ ruby optparse-test.rb --user 3
# optparse-test.rb:15:in `block in find_user': No User Found for id 3 (RuntimeError) # optparse-test.rb:15:in 'block in find_user': No User Found for id 3 (RuntimeError)
# #
# === Store options to a Hash # === Store options to a Hash
# #