Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Update docs for String#split #13153

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 23, 2025
Merged

Update docs for String#split #13153

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eb45142
Update docs for String#split
dcr8898 Apr 23, 2025
5c29ab4
Regrettable comma and minor update
dcr8898 Apr 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 28 additions & 13 deletions doc/string/split.rdoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,31 +15,31 @@ When +field_sep+ is <tt>$;</tt>:
When +field_sep+ is <tt>' '</tt> and +limit+ is +0+ (its default value),
the split occurs at each sequence of whitespace:

'abc def ghi'.split(' ') => ["abc", "def", "ghi"]
'abc def ghi'.split(' ') # => ["abc", "def", "ghi"]
"abc \n\tdef\t\n ghi".split(' ') # => ["abc", "def", "ghi"]
'abc def ghi'.split(' ') => ["abc", "def", "ghi"]
''.split(' ') => []
'abc def ghi'.split(' ') # => ["abc", "def", "ghi"]
''.split(' ') # => []

When +field_sep+ is a string different from <tt>' '</tt>
and +limit+ is +0+,
the split occurs at each occurrence of +field_sep+;
trailing empty substrings are not returned:

'abracadabra'.split('ab') => ["", "racad", "ra"]
'aaabcdaaa'.split('a') => ["", "", "", "bcd"]
''.split('a') => []
'3.14159'.split('1') => ["3.", "4", "59"]
'abracadabra'.split('ab') # => ["", "racad", "ra"]
'aaabcdaaa'.split('a') # => ["", "", "", "bcd"]
''.split('a') # => []
'3.14159'.split('1') # => ["3.", "4", "59"]
'!@#$%^$&*($)_+'.split('$') # => ["!@#", "%^", "&*(", ")_+"]
'тест'.split('т') => ["", "ес"]
'こんにちは'.split('に') => ["こん", "ちは"]
'тест'.split('т') # => ["", "ес"]
'こんにちは'.split('に') # => ["こん", "ちは"]

When +field_sep+ is a Regexp and +limit+ is +0+,
the split occurs at each occurrence of a match;
trailing empty substrings are not returned:

'abracadabra'.split(/ab/) # => ["", "racad", "ra"]
'aaabcdaaa'.split(/a/) => ["", "", "", "bcd"]
'aaabcdaaa'.split(//) => ["a", "a", "a", "b", "c", "d", "a", "a", "a"]
'aaabcdaaa'.split(/a/) # => ["", "", "", "bcd"]
'aaabcdaaa'.split(//) # => ["a", "a", "a", "b", "c", "d", "a", "a", "a"]
'1 + 1 == 2'.split(/\W+/) # => ["1", "1", "2"]

If the \Regexp contains groups, their matches are also included
Expand All @@ -50,7 +50,7 @@ in the returned array:
As seen above, if +limit+ is +0+,
trailing empty substrings are not returned:

'aaabcdaaa'.split('a') => ["", "", "", "bcd"]
'aaabcdaaa'.split('a') # => ["", "", "", "bcd"]

If +limit+ is positive integer +n+, no more than <tt>n - 1-</tt>
splits occur, so that at most +n+ substrings are returned,
Expand All @@ -71,7 +71,7 @@ and trailing empty substrings are included:

'aaabcdaaa'.split('a', -1) # => ["", "", "", "bcd", "", "", ""]

If a block is given, it is called with each substring:
If a block is given, it is called with each substring and returns +self+:

'abc def ghi'.split(' ') {|substring| p substring }

Expand All @@ -80,5 +80,20 @@ Output:
"abc"
"def"
"ghi"
=> "abc def ghi"

Note that the above example is functionally the same as calling +#each+ after
+#split+ and giving the same block. However, the above example has better
performance because it avoids the creation of an intermediate array. Also,
note the different return values.

'abc def ghi'.split(' ').each {|substring| p substring }

Output:

"abc"
"def"
"ghi"
=> ["abc", "def", "ghi"]

Related: String#partition, String#rpartition.