summaryrefslogtreecommitdiff
path: root/re.c
diff options
context:
space:
mode:
authordrbrain <drbrain@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2012-08-20 20:19:21 +0000
committerdrbrain <drbrain@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2012-08-20 20:19:21 +0000
commitdecaaf845e78df6e3d888cf340a459a4a1984abe (patch)
treedeec5ce5c21c9e4eb3ec7c8fbd2b5d4a4290f71e /re.c
parentdde9f6958d169fe8d4f7f4c6cbc1e2e7f80a8683 (diff)
* re.c (rb_reg_initialize_m): Update example to show that regexp
options use | an not || to avoid confusion. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@36740 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 're.c')
-rw-r--r--re.c23
1 files changed, 12 insertions, 11 deletions
diff --git a/re.c b/re.c
index 15bdcc8..e816777 100644
--- a/re.c
+++ b/re.c
@@ -2877,20 +2877,21 @@ rb_reg_match_m(int argc, VALUE *argv, VALUE re)
* Regexp.compile(string, [options [, lang]]) -> regexp
* Regexp.compile(regexp) -> regexp
*
- * Constructs a new regular expression from <i>pattern</i>, which can be either
- * a <code>String</code> or a <code>Regexp</code> (in which case that regexp's
- * options are propagated, and new options may not be specified (a change as of
- * Ruby 1.8). If <i>options</i> is a <code>Fixnum</code>, it should be one or
- * more of the constants <code>Regexp::EXTENDED</code>,
- * <code>Regexp::IGNORECASE</code>, and <code>Regexp::MULTILINE</code>,
- * <em>or</em>-ed together. Otherwise, if <i>options</i> is not
- * <code>nil</code>, the regexp will be case insensitive.
- * When the <i>lang</i> parameter is `n' or `N' sets the regexp no encoding.
+ * Constructs a new regular expression from +pattern+, which can be either a
+ * String or a Regexp (in which case that regexp's options are propagated),
+ * and new options may not be specified (a change as of Ruby 1.8).
+ *
+ * If +options+ is a Fixnum, it should be one or more of the constants
+ * Regexp::EXTENDED, Regexp::IGNORECASE, and Regexp::MULTILINE,
+ * <em>or</em>-ed together. Otherwise, if +options+ is not
+ * +nil+ or +false+, the regexp will be case insensitive.
+ *
+ * When the +lang+ parameter is `n' or `N' sets the regexp no encoding.
*
* r1 = Regexp.new('^a-z+:\\s+\w+') #=> /^a-z+:\s+\w+/
* r2 = Regexp.new('cat', true) #=> /cat/i
- * r3 = Regexp.new('dog', Regexp::EXTENDED) #=> /dog/x
- * r4 = Regexp.new(r2) #=> /cat/i
+ * r3 = Regexp.new(r2) #=> /cat/i
+ * r4 = Regexp.new('dog', Regexp::EXTENDED | Regexp::IGNORECASE) #=> /dog/x
*/
static VALUE