diff options
author | nobu <nobu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2018-06-08 10:45:01 +0000 |
---|---|---|
committer | nobu <nobu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2018-06-08 10:45:01 +0000 |
commit | 46d7dc11621d47ded755fe827814a1581e1ab29f (patch) | |
tree | 8316f1d77ad2eace985f6e305e5cd7db74e72665 /string.c | |
parent | dc1f272ee6299062391da0c36431d2a9423e7d3a (diff) | |
download | ruby-46d7dc11621d47ded755fe827814a1581e1ab29f.tar.gz |
[Docs] Improve documentation of String#lines
* Document about optional getline arguments
* Add examples, especially for the demonstration of `chomp: true`
[Fix GH-1886]
From: Koki Takahashi <hakatasiloving@gmail.com>
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@63610 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'string.c')
-rw-r--r-- | string.c | 10 |
1 files changed, 8 insertions, 2 deletions
@@ -8174,11 +8174,17 @@ rb_str_each_line(int argc, VALUE *argv, VALUE str) /* * call-seq: - * str.lines(separator=$/) -> an_array + * str.lines(separator=$/ [, getline_args]) -> an_array * * Returns an array of lines in <i>str</i> split using the supplied * record separator (<code>$/</code> by default). This is a - * shorthand for <code>str.each_line(separator).to_a</code>. + * shorthand for <code>str.each_line(separator, getline_args).to_a</code>. + * + * See IO.readlines for details about getline_args. + * + * "hello\nworld\n".lines #=> ["hello\n", "world\n"] + * "hello world".lines(' ') #=> ["hello ", " ", "world"] + * "hello\nworld\n".lines(chomp: true) #=> ["hello", "world"] * * If a block is given, which is a deprecated form, works the same as * <code>each_line</code>. |