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

OptionParser: document into: argument

Browse Source
This commit is contained in:
zverok 2019-10-26 11:46:54 +03:00 committed by Takashi Kokubun
parent a24bff461d
commit f93cb6904c
Notes: git 2019-10-27 02:25:03 +09:00 
Merged: https://github.com/ruby/ruby/pull/2615
1 changed files with 12 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
lib/optparse.rb
View File

@ -169,7 +169,7 @@
# - Array -- Strings separated by ',' (e.g. 1,2,3) # - Array -- Strings separated by ',' (e.g. 1,2,3)
# - Regexp -- Regular expressions. Also includes options. # - Regexp -- Regular expressions. Also includes options.
# #
# We can also add our own coercions, which we will cover soon. # We can also add our own coercions, which we will cover below.
# #
# ==== Using Built-in Conversions # ==== Using Built-in Conversions
# #
@ -1548,7 +1548,10 @@ XXX
# #
# Parses command line arguments +argv+ in order. When a block is given, # Parses command line arguments +argv+ in order. When a block is given,
# each non-option argument is yielded. # each non-option argument is yielded. When optional +into+ keyword
# argument is provided, the parsed option values are stored there via
# <code>[]=</code> method (so it can be Hash, or OpenStruct, or other
# similar object).
# #
# Returns the rest of +argv+ left unparsed. # Returns the rest of +argv+ left unparsed.
# #
@ -1644,7 +1647,10 @@ XXX
# #
# Parses command line arguments +argv+ in permutation mode and returns # Parses command line arguments +argv+ in permutation mode and returns
# list of non-option arguments. # list of non-option arguments. When optional +into+ keyword
# argument is provided, the parsed option values are stored there via
# <code>[]=</code> method (so it can be Hash, or OpenStruct, or other
# similar object).
# #
def permute(*argv, into: nil) def permute(*argv, into: nil)
argv = argv[0].dup if argv.size == 1 and Array === argv[0] argv = argv[0].dup if argv.size == 1 and Array === argv[0]
@ -1665,6 +1671,9 @@ XXX
# #
# Parses command line arguments +argv+ in order when environment variable # Parses command line arguments +argv+ in order when environment variable
# POSIXLY_CORRECT is set, and in permutation mode otherwise. # POSIXLY_CORRECT is set, and in permutation mode otherwise.
# When optional +into+ keyword argument is provided, the parsed option
# values are stored there via <code>[]=</code> method (so it can be Hash,
# or OpenStruct, or other similar object).
# #
def parse(*argv, into: nil) def parse(*argv, into: nil)
argv = argv[0].dup if argv.size == 1 and Array === argv[0] argv = argv[0].dup if argv.size == 1 and Array === argv[0]