From 33cfc7250bbad67938b9852ca277c047395fda9e Mon Sep 17 00:00:00 2001 From: stomar Date: Fri, 2 Jun 2017 21:29:27 +0000 Subject: string.c: docs for String#split * string.c: [DOC] clarify docs for String#split when called with limit and capture groups. Reported by Cichol Tsai. [ruby-core:81505] [Bug #13621] git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@59002 b2dd03c8-39d4-4d8f-98ff-823fe69b080e --- string.c | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) (limited to 'string.c') diff --git a/string.c b/string.c index df3f8fd3cd..cd633e1226 100644 --- a/string.c +++ b/string.c @@ -7285,7 +7285,7 @@ static const char isspacetable[256] = { /* * call-seq: - * str.split(pattern=nil, [limit]) -> anArray + * str.split(pattern=nil, [limit]) -> an_array * * Divides str into substrings based on a delimiter, returning an array * of these substrings. @@ -7305,9 +7305,11 @@ static const char isspacetable[256] = { * split on whitespace as if ' ' were specified. * * If the limit parameter is omitted, trailing null fields are - * suppressed. If limit is a positive number, at most that number of - * fields will be returned (if limit is 1, the entire - * string is returned as the only entry in an array). If negative, there is no + * suppressed. If limit is a positive number, at most that number + * of split substrings will be returned (captured groups will be returned + * as well, but are not counted towards the limit). + * If limit is 1, the entire + * string is returned as the only entry in an array. If negative, there is no * limit to the number of fields returned, and trailing null fields are not * suppressed. * @@ -7327,6 +7329,8 @@ static const char isspacetable[256] = { * "1,2,,3,4,,".split(',', 4) #=> ["1", "2", "", "3,4,,"] * "1,2,,3,4,,".split(',', -4) #=> ["1", "2", "", "3", "4", "", ""] * + * "1:2:3".split(/(:)()()/, 2) #=> ["1", ":", "", "", "2:3"] + * * "".split(',', -1) #=> [] */ -- cgit v1.2.3