From d9b8411a7be4c9e300b75bc374f29e6965ab3040 Mon Sep 17 00:00:00 2001
From: Jeremy Evans <code@jeremyevans.net>
Date: Wed, 2 Sep 2020 10:40:17 -0700
Subject: Document that StringScanner#matched_size returns size in bytes [ci
 skip]

Fixes [Bug #17139]
---
 ext/strscan/strscan.c | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

(limited to 'ext')

diff --git a/ext/strscan/strscan.c b/ext/strscan/strscan.c
index 7edd1bf0c2..61c8d8972c 100644
--- a/ext/strscan/strscan.c
+++ b/ext/strscan/strscan.c
@@ -1089,8 +1089,9 @@ strscan_matched(VALUE self)
 }
 
 /*
- * Returns the size of the most recent match (see #matched), or +nil+ if there
- * was no recent match.
+ * Returns the size of the most recent match in bytes, or +nil+ if there
+ * was no recent match.  This is different than <tt>matched.size</tt>,
+ * which will return the size in characters.
  *
  *   s = StringScanner.new('test string')
  *   s.check /\w+/           # -> "test"
-- 
cgit v1.2.3