diff options
| author | zverok <zverok.offline@gmail.com> | 2019-10-26 11:46:54 +0300 |
|---|---|---|
| committer | Takashi Kokubun <takashikkbn@gmail.com> | 2019-10-26 10:24:20 -0700 |
| commit | f93cb6904c69de51bf14b1bcf9fcfc483584f4d3 (patch) | |
| tree | e1cb407074e7b892741b71a7c5608f383014c458 | |
| parent | a24bff461d67e8d5e1f076a9ce773bc876a8b3d4 (diff) | |
| download | ruby-f93cb6904c69de51bf14b1bcf9fcfc483584f4d3.tar.gz | |
OptionParser: document into: argument
| -rw-r--r-- | lib/optparse.rb | 15 |
1 files changed, 12 insertions, 3 deletions
diff --git a/lib/optparse.rb b/lib/optparse.rb index 9745e4d662..b6d7170487 100644 --- a/lib/optparse.rb +++ b/lib/optparse.rb @@ -169,7 +169,7 @@ # - Array -- Strings separated by ',' (e.g. 1,2,3) # - 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 # @@ -1548,7 +1548,10 @@ XXX # # 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. # @@ -1644,7 +1647,10 @@ XXX # # 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) 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 # 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) argv = argv[0].dup if argv.size == 1 and Array === argv[0] |