summaryrefslogtreecommitdiff
path: root/re.c
diff options
context:
space:
mode:
authorJeremy Evans <code@jeremyevans.net>2019-07-22 14:43:36 -0700
committerJeremy Evans <code@jeremyevans.net>2019-07-22 14:43:36 -0700
commit32ec6dd5c7cb89979d48100acf8971ac09e0d02e (patch)
tree8c00146bc9a820278ec49d1a786d106b93db7906 /re.c
parentc1ad6321b03bcf9f96f975bcba7ff1d205990149 (diff)
Document encoding of string returned by Regexp.quote [ci skip]
Also, remove documentation about returning self, which makes no sense as self would be the Regexp class. It could be interpreted as return the argument if no changes were made, but that hasn't been the behavior at least since 1.8.7 (and probably before). Fixes [Bug #10239]
Diffstat (limited to 're.c')
-rw-r--r--re.c4
1 files changed, 2 insertions, 2 deletions
diff --git a/re.c b/re.c
index 9941cf2deb..969c1ec7b4 100644
--- a/re.c
+++ b/re.c
@@ -3578,8 +3578,8 @@ rb_reg_quote(VALUE str)
* Regexp.quote(str) -> string
*
* Escapes any characters that would have special meaning in a regular
- * expression. Returns a new escaped string, or self if no characters are
- * escaped. For any string,
+ * expression. Returns a new escaped string with the same or compatible
+ * encoding. For any string,
* <code>Regexp.new(Regexp.escape(<i>str</i>))=~<i>str</i></code> will be true.
*
* Regexp.escape('\*?{}.') #=> \\\*\?\{\}\.