summaryrefslogtreecommitdiff
path: root/re.c
diff options
context:
space:
mode:
authorNobuyoshi Nakada <nobu@ruby-lang.org>2022-06-20 02:32:17 +0900
committerNobuyoshi Nakada <nobu@ruby-lang.org>2022-06-20 09:26:11 +0900
commitcd3a5cd0e33f7b2495c5b3421e7f1d124de8c343 (patch)
tree95ab3b9e5765516f570bee52fef0c963f5491067 /re.c
parent6622a41891d4b566f1668db4be58dd19a3e24102 (diff)
downloadruby-cd3a5cd0e33f7b2495c5b3421e7f1d124de8c343.tar.gz
[DOC] Fixed omissions in Regexp.new arguments
Diffstat (limited to 're.c')
-rw-r--r--re.c8
1 files changed, 6 insertions, 2 deletions
diff --git a/re.c b/re.c
index 2093d1ace4..6a6aa69cec 100644
--- a/re.c
+++ b/re.c
@@ -3633,8 +3633,8 @@ rb_reg_match_p(VALUE re, VALUE str, long pos)
/*
* call-seq:
- * Regexp.new(string, options = 0, timeout: nil) -> regexp
- * Regexp.new(regexp) -> regexp
+ * Regexp.new(string, options = 0, encoding = nil, timeout: nil) -> regexp
+ * Regexp.new(regexp, timeout: nil) -> regexp
*
* With argument +string+ given, returns a new regexp with the given string
* and options:
@@ -3656,6 +3656,10 @@ rb_reg_match_p(VALUE re, VALUE str, long pos)
*
* - +nil+ or +false+, which is ignored.
*
+ * If optional argument +encoding+ is a string starts with
+ * <code>'n'</code>, the encoding of +string+ is ignored and the new
+ * regexp encoding is fixed to +ASCII_8BIT+.
+ *
* If optional keyword argument +timeout+ is given,
* its integer value overrides the timeout interval for the class,
* Regexp.timeout.