summaryrefslogtreecommitdiff
path: root/re.c
diff options
context:
space:
mode:
authorNobuyoshi Nakada <nobu@ruby-lang.org>2022-08-18 23:25:05 +0900
committerNobuyoshi Nakada <nobu@ruby-lang.org>2022-08-18 23:25:05 +0900
commitc53667691a52bcaea4314974201c53dfc282cd95 (patch)
tree33df544f929820e0476fb3abccefe7a3dd6012b6 /re.c
parentb0b9f7201acab05c2a3ad92c3043a1f01df3e17f (diff)
downloadruby-c53667691a52bcaea4314974201c53dfc282cd95.tar.gz
[DOC] `offset` argument of Regexp#match
Diffstat (limited to 're.c')
-rw-r--r--re.c7
1 files changed, 6 insertions, 1 deletions
diff --git a/re.c b/re.c
index a633d1bb7b..5091f9a124 100644
--- a/re.c
+++ b/re.c
@@ -3499,13 +3499,18 @@ rb_reg_match2(VALUE re)
*
* With no block given, returns the MatchData object
* that describes the match, if any, or +nil+ if none;
- * the search begins at the given byte +offset+ in +self+:
+ * the search begins at the given character +offset+ in +string+:
*
* /abra/.match('abracadabra') # => #<MatchData "abra">
* /abra/.match('abracadabra', 4) # => #<MatchData "abra">
* /abra/.match('abracadabra', 8) # => nil
* /abra/.match('abracadabra', 800) # => nil
*
+ * string = "\u{5d0 5d1 5e8 5d0}cadabra"
+ * /abra/.match(string, 7) #=> #<MatchData "abra">
+ * /abra/.match(string, 8) #=> nil
+ * /abra/.match(string.b, 8) #=> #<MatchData "abra">
+ *
* With a block given, calls the block if and only if a match is found;
* returns the block's value:
*