Skip to content

Commit 9de9cb5

Browse files
nobumatzbot
nobu
authored and
matzbot
committed
[ruby/optparse] [DOC] Update documents to use single quotes instead of backqoutes
ruby/optparse@5e71a70cb5
1 parent 1a985d3 commit 9de9cb5

File tree

4 files changed

+34
-33
lines changed

4 files changed

+34
-33
lines changed

‎doc/optparse/argument_converters.rdoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -377,4 +377,4 @@ Executions:
377377
$ ruby match_converter.rb --capitalize foo
378378
["Foo", String]
379379
$ ruby match_converter.rb --capitalize "foo bar"
380-
match_converter.rb:9:in `<main>': invalid argument: --capitalize foo bar (OptionParser::InvalidArgument)
380+
match_converter.rb:9:in '<main>': invalid argument: --capitalize foo bar (OptionParser::InvalidArgument)

‎doc/optparse/option_params.rdoc‎

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ Executions:
9191
Usage: short_required [options]
9292
-xXXX Short name with required argument
9393
$ ruby short_required.rb -x
94-
short_required.rb:6:in `<main>': missing argument: -x (OptionParser::MissingArgument)
94+
short_required.rb:6:in '<main>': missing argument: -x (OptionParser::MissingArgument)
9595
$ ruby short_required.rb -x FOO
9696
["-x", "FOO"]
9797

@@ -181,7 +181,7 @@ Executions:
181181
Usage: long_required [options]
182182
--xxx XXX Long name with required argument
183183
$ ruby long_required.rb --xxx
184-
long_required.rb:6:in `<main>': missing argument: --xxx (OptionParser::MissingArgument)
184+
long_required.rb:6:in '<main>': missing argument: --xxx (OptionParser::MissingArgument)
185185
$ ruby long_required.rb --xxx FOO
186186
["--xxx", "FOO"]
187187

@@ -243,11 +243,11 @@ Usage: mixed_names [options]
243243
$ ruby mixed_names.rb --xxx
244244
["--xxx", true]
245245
$ ruby mixed_names.rb -y
246-
mixed_names.rb:12:in `<main>': missing argument: -y (OptionParser::MissingArgument)
246+
mixed_names.rb:12:in '<main>': missing argument: -y (OptionParser::MissingArgument)
247247
$ ruby mixed_names.rb -y FOO
248248
["--yyy", "FOO"]
249249
$ ruby mixed_names.rb --yyy
250-
mixed_names.rb:12:in `<main>': missing argument: --yyy (OptionParser::MissingArgument)
250+
mixed_names.rb:12:in '<main>': missing argument: --yyy (OptionParser::MissingArgument)
251251
$ ruby mixed_names.rb --yyy BAR
252252
["--yyy", "BAR"]
253253
$ ruby mixed_names.rb -z
@@ -279,7 +279,7 @@ Executions:
279279
Usage: argument_keywords [options]
280280
-x, --xxx Required argument
281281
$ ruby argument_styles.rb --xxx
282-
argument_styles.rb:6:in `<main>': missing argument: --xxx (OptionParser::MissingArgument)
282+
argument_styles.rb:6:in '<main>': missing argument: --xxx (OptionParser::MissingArgument)
283283
$ ruby argument_styles.rb --xxx FOO
284284
["--xxx", "FOO"]
285285

@@ -298,7 +298,7 @@ Executions:
298298
Usage: argument_strings [options]
299299
-x, --xxx=XXX Required argument
300300
$ ruby argument_strings.rb --xxx
301-
argument_strings.rb:9:in `<main>': missing argument: --xxx (OptionParser::MissingArgument)
301+
argument_strings.rb:9:in '<main>': missing argument: --xxx (OptionParser::MissingArgument)
302302
$ ruby argument_strings.rb --xxx FOO
303303
["--xxx", "FOO"]
304304

@@ -331,17 +331,17 @@ Executions:
331331
-xXXX Values for required argument
332332
-y [YYY] Values for optional argument
333333
$ ruby explicit_array_values.rb -x
334-
explicit_array_values.rb:9:in `<main>': missing argument: -x (OptionParser::MissingArgument)
334+
explicit_array_values.rb:9:in '<main>': missing argument: -x (OptionParser::MissingArgument)
335335
$ ruby explicit_array_values.rb -x foo
336336
["-x", "foo"]
337337
$ ruby explicit_array_values.rb -x f
338338
["-x", "foo"]
339339
$ ruby explicit_array_values.rb -x bar
340340
["-x", "bar"]
341341
$ ruby explicit_array_values.rb -y ba
342-
explicit_array_values.rb:9:in `<main>': ambiguous argument: -y ba (OptionParser::AmbiguousArgument)
342+
explicit_array_values.rb:9:in '<main>': ambiguous argument: -y ba (OptionParser::AmbiguousArgument)
343343
$ ruby explicit_array_values.rb -x baz
344-
explicit_array_values.rb:9:in `<main>': invalid argument: -x baz (OptionParser::InvalidArgument)
344+
explicit_array_values.rb:9:in '<main>': invalid argument: -x baz (OptionParser::InvalidArgument)
345345

346346

347347
===== Explicit Values in Hash
@@ -361,30 +361,31 @@ Executions:
361361
-xXXX Values for required argument
362362
-y [YYY] Values for optional argument
363363
$ ruby explicit_hash_values.rb -x
364-
explicit_hash_values.rb:9:in `<main>': missing argument: -x (OptionParser::MissingArgument)
364+
explicit_hash_values.rb:9:in '<main>': missing argument: -x (OptionParser::MissingArgument)
365365
$ ruby explicit_hash_values.rb -x foo
366366
["-x", 0]
367367
$ ruby explicit_hash_values.rb -x f
368368
["-x", 0]
369369
$ ruby explicit_hash_values.rb -x bar
370370
["-x", 1]
371371
$ ruby explicit_hash_values.rb -x baz
372-
explicit_hash_values.rb:9:in `<main>': invalid argument: -x baz (OptionParser::InvalidArgument)
372+
explicit_hash_values.rb:9:in '<main>': invalid argument: -x baz (OptionParser::InvalidArgument)
373373
$ ruby explicit_hash_values.rb -y
374374
["-y", nil]
375375
$ ruby explicit_hash_values.rb -y baz
376376
["-y", 2]
377377
$ ruby explicit_hash_values.rb -y bat
378378
["-y", 3]
379379
$ ruby explicit_hash_values.rb -y ba
380-
explicit_hash_values.rb:9:in `<main>': ambiguous argument: -y ba (OptionParser::AmbiguousArgument)
380+
explicit_hash_values.rb:9:in '<main>': ambiguous argument: -y ba (OptionParser::AmbiguousArgument)
381381
$ ruby explicit_hash_values.rb -y bam
382382
["-y", nil]
383383

384384
==== Argument Value Patterns
385385

386386
You can restrict permissible argument values
387-
by specifying a Regexp that the given argument must match.
387+
by specifying a +Regexp+ that the given argument must match,
388+
or a +Range+ or +Array+ that the converted value must be included in.
388389

389390
File +matched_values.rb+ defines options with matched argument values.
390391

@@ -400,7 +401,7 @@ Executions:
400401
$ ruby matched_values.rb --xxx FOO
401402
["--xxx", "FOO"]
402403
$ ruby matched_values.rb --xxx bar
403-
matched_values.rb:6:in `<main>': invalid argument: --xxx bar (OptionParser::InvalidArgument)
404+
matched_values.rb:6:in '<main>': invalid argument: --xxx bar (OptionParser::InvalidArgument)
404405

405406
=== Argument Converters
406407

‎doc/optparse/tutorial.rdoc‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ Executions:
111111
["x", true]
112112
["input_file.txt", "output_file.txt"]
113113
$ ruby basic.rb -a
114-
basic.rb:16:in `<main>': invalid option: -a (OptionParser::InvalidOption)
114+
basic.rb:16:in '<main>': invalid option: -a (OptionParser::InvalidOption)
115115

116116
=== Defining Options
117117

@@ -232,11 +232,11 @@ Executions:
232232
$ ruby mixed_names.rb --xxx
233233
["--xxx", true]
234234
$ ruby mixed_names.rb -y
235-
mixed_names.rb:12:in `<main>': missing argument: -y (OptionParser::MissingArgument)
235+
mixed_names.rb:12:in '<main>': missing argument: -y (OptionParser::MissingArgument)
236236
$ ruby mixed_names.rb -y FOO
237237
["--yyy", "FOO"]
238238
$ ruby mixed_names.rb --yyy
239-
mixed_names.rb:12:in `<main>': missing argument: --yyy (OptionParser::MissingArgument)
239+
mixed_names.rb:12:in '<main>': missing argument: --yyy (OptionParser::MissingArgument)
240240
$ ruby mixed_names.rb --yyy BAR
241241
["--yyy", "BAR"]
242242
$ ruby mixed_names.rb -z
@@ -270,9 +270,9 @@ Executions:
270270
$ ruby name_abbrev.rb --draft
271271
["--draft", true]
272272
$ ruby name_abbrev.rb --d
273-
name_abbrev.rb:9:in `<main>': ambiguous option: --d (OptionParser::AmbiguousOption)
273+
name_abbrev.rb:9:in '<main>': ambiguous option: --d (OptionParser::AmbiguousOption)
274274
$ ruby name_abbrev.rb --dr
275-
name_abbrev.rb:9:in `<main>': ambiguous option: --dr (OptionParser::AmbiguousOption)
275+
name_abbrev.rb:9:in '<main>': ambiguous option: --dr (OptionParser::AmbiguousOption)
276276
$ ruby name_abbrev.rb --dry
277277
["--dry-run", true]
278278
$ ruby name_abbrev.rb --dra
@@ -285,7 +285,7 @@ You can disable abbreviation using method +require_exact+.
285285
Executions:
286286

287287
$ ruby no_abbreviation.rb --dry-ru
288-
no_abbreviation.rb:10:in `<main>': invalid option: --dry-ru (OptionParser::InvalidOption)
288+
no_abbreviation.rb:10:in '<main>': invalid option: --dry-ru (OptionParser::InvalidOption)
289289
$ ruby no_abbreviation.rb --dry-run
290290
["--dry-run", true]
291291

@@ -323,7 +323,7 @@ Executions:
323323
Omitting a required argument raises an error:
324324

325325
$ ruby required_argument.rb -x
326-
required_argument.rb:9:in `<main>': missing argument: -x (OptionParser::MissingArgument)
326+
required_argument.rb:9:in '<main>': missing argument: -x (OptionParser::MissingArgument)
327327

328328
==== Option with Optional Argument
329329

@@ -369,7 +369,7 @@ Executions:
369369
$ ruby argument_abbreviation.rb --xxx A
370370
["--xxx", "ABC"]
371371
$ ruby argument_abbreviation.rb --xxx c
372-
argument_abbreviation.rb:9:in `<main>': invalid argument: --xxx c (OptionParser::InvalidArgument)
372+
argument_abbreviation.rb:9:in '<main>': invalid argument: --xxx c (OptionParser::InvalidArgument)
373373
$ ruby argument_abbreviation.rb --yyy a --yyy d
374374
["--yyy", "XYZ"]
375375
["--yyy", "FOO"]
@@ -403,17 +403,17 @@ Executions:
403403
-xXXX Values for required argument
404404
-y [YYY] Values for optional argument
405405
$ ruby explicit_array_values.rb -x
406-
explicit_array_values.rb:9:in `<main>': missing argument: -x (OptionParser::MissingArgument)
406+
explicit_array_values.rb:9:in '<main>': missing argument: -x (OptionParser::MissingArgument)
407407
$ ruby explicit_array_values.rb -x foo
408408
["-x", "foo"]
409409
$ ruby explicit_array_values.rb -x f
410410
["-x", "foo"]
411411
$ ruby explicit_array_values.rb -x bar
412412
["-x", "bar"]
413413
$ ruby explicit_array_values.rb -y ba
414-
explicit_array_values.rb:9:in `<main>': ambiguous argument: -y ba (OptionParser::AmbiguousArgument)
414+
explicit_array_values.rb:9:in '<main>': ambiguous argument: -y ba (OptionParser::AmbiguousArgument)
415415
$ ruby explicit_array_values.rb -x baz
416-
explicit_array_values.rb:9:in `<main>': invalid argument: -x baz (OptionParser::InvalidArgument)
416+
explicit_array_values.rb:9:in '<main>': invalid argument: -x baz (OptionParser::InvalidArgument)
417417

418418

419419
===== Explicit Values in Hash
@@ -433,23 +433,23 @@ Executions:
433433
-xXXX Values for required argument
434434
-y [YYY] Values for optional argument
435435
$ ruby explicit_hash_values.rb -x
436-
explicit_hash_values.rb:9:in `<main>': missing argument: -x (OptionParser::MissingArgument)
436+
explicit_hash_values.rb:9:in '<main>': missing argument: -x (OptionParser::MissingArgument)
437437
$ ruby explicit_hash_values.rb -x foo
438438
["-x", 0]
439439
$ ruby explicit_hash_values.rb -x f
440440
["-x", 0]
441441
$ ruby explicit_hash_values.rb -x bar
442442
["-x", 1]
443443
$ ruby explicit_hash_values.rb -x baz
444-
explicit_hash_values.rb:9:in `<main>': invalid argument: -x baz (OptionParser::InvalidArgument)
444+
explicit_hash_values.rb:9:in '<main>': invalid argument: -x baz (OptionParser::InvalidArgument)
445445
$ ruby explicit_hash_values.rb -y
446446
["-y", nil]
447447
$ ruby explicit_hash_values.rb -y baz
448448
["-y", 2]
449449
$ ruby explicit_hash_values.rb -y bat
450450
["-y", 3]
451451
$ ruby explicit_hash_values.rb -y ba
452-
explicit_hash_values.rb:9:in `<main>': ambiguous argument: -y ba (OptionParser::AmbiguousArgument)
452+
explicit_hash_values.rb:9:in '<main>': ambiguous argument: -y ba (OptionParser::AmbiguousArgument)
453453
$ ruby explicit_hash_values.rb -y bam
454454
["-y", nil]
455455

@@ -472,7 +472,7 @@ Executions:
472472
$ ruby matched_values.rb --xxx FOO
473473
["--xxx", "FOO"]
474474
$ ruby matched_values.rb --xxx bar
475-
matched_values.rb:6:in `<main>': invalid argument: --xxx bar (OptionParser::InvalidArgument)
475+
matched_values.rb:6:in '<main>': invalid argument: --xxx bar (OptionParser::InvalidArgument)
476476

477477
=== Keyword Argument +into+
478478

@@ -524,7 +524,7 @@ Executions:
524524
-y, --yyyYYY Short and long, required argument
525525
-z, --zzz [ZZZ] Short and long, optional argument
526526
$ ruby missing_options.rb --yyy FOO
527-
missing_options.rb:11:in `<main>': Missing required options: [:xxx, :zzz] (RuntimeError)
527+
missing_options.rb:11:in '<main>': Missing required options: [:xxx, :zzz] (RuntimeError)
528528

529529
==== Default Values for Options
530530

‎lib/optparse.rb‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@
142142
# Used:
143143
#
144144
# $ ruby optparse-test.rb -r
145-
# optparse-test.rb:9:in `<main>': missing argument: -r (OptionParser::MissingArgument)
145+
# optparse-test.rb:9:in '<main>': missing argument: -r (OptionParser::MissingArgument)
146146
# $ ruby optparse-test.rb -r my-library
147147
# You required my-library!
148148
#
@@ -235,7 +235,7 @@
235235
# $ ruby optparse-test.rb --user 2
236236
# #<struct User id=2, name="Gandalf">
237237
# $ ruby optparse-test.rb --user 3
238-
# optparse-test.rb:15:in `block in find_user': No User Found for id 3 (RuntimeError)
238+
# optparse-test.rb:15:in 'block in find_user': No User Found for id 3 (RuntimeError)
239239
#
240240
# === Store options to a Hash
241241
#

0 commit comments

Comments
 (0)