-
Notifications
You must be signed in to change notification settings - Fork 5.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[DOC] Enhanced RDoc for MatchData (#5819)
Treats: #begin #end #match #match_length
- Loading branch information
1 parent
9d1dd7a
commit b074bc3
Showing
4 changed files
with
107 additions
and
46 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
Returns the offset (in characters) of the beginning of the specified match. | ||
|
||
When non-negative integer argument +n+ is given, | ||
returns the offset of the beginning of the <tt>n</tt>th match: | ||
|
||
m = /(.)(.)(\d+)(\d)/.match("THX1138.") | ||
# => #<MatchData "HX1138" 1:"H" 2:"X" 3:"113" 4:"8"> | ||
m[0] # => "HX1138" | ||
m.begin(0) # => 1 | ||
m[3] # => "113" | ||
m.begin(3) # => 3 | ||
|
||
m = /(т)(е)(с)/.match('тест') | ||
# => #<MatchData "тес" 1:"т" 2:"е" 3:"с"> | ||
m[0] # => "тес" | ||
m.begin(0) # => 0 | ||
m[3] # => "с" | ||
m.begin(3) # => 2 | ||
|
||
When string or symbol argument +name+ is given, | ||
returns the offset of the beginning for the named match: | ||
|
||
m = /(?<foo>.)(.)(?<bar>.)/.match("hoge") | ||
# => #<MatchData "hog" foo:"h" bar:"g"> | ||
m[:foo] # => "h" | ||
m.begin('foo') # => 0 | ||
m[:bar] # => "g" | ||
m.begin(:bar) # => 2 | ||
|
||
Related: MatchData#end, MatchData#offset, MatchData#byteoffset. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
Returns the offset (in characters) of the end of the specified match. | ||
|
||
When non-negative integer argument +n+ is given, | ||
returns the offset of the end of the <tt>n</tt>th match: | ||
|
||
m = /(.)(.)(\d+)(\d)/.match("THX1138.") | ||
# => #<MatchData "HX1138" 1:"H" 2:"X" 3:"113" 4:"8"> | ||
m[0] # => "HX1138" | ||
m.end(0) # => 7 | ||
m[3] # => "113" | ||
m.end(3) # => 6 | ||
|
||
m = /(т)(е)(с)/.match('тест') | ||
# => #<MatchData "тес" 1:"т" 2:"е" 3:"с"> | ||
m[0] # => "тес" | ||
m.end(0) # => 3 | ||
m[3] # => "с" | ||
m.end(3) # => 3 | ||
|
||
When string or symbol argument +name+ is given, | ||
returns the offset of the end for the named match: | ||
|
||
m = /(?<foo>.)(.)(?<bar>.)/.match("hoge") | ||
# => #<MatchData "hog" foo:"h" bar:"g"> | ||
m[:foo] # => "h" | ||
m.end('foo') # => 1 | ||
m[:bar] # => "g" | ||
m.end(:bar) # => 3 | ||
|
||
Related: MatchData#begin, MatchData#offset, MatchData#byteoffset. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters