* doc/re.rdoc: Completed wording in the description of the =~ operator.

[ruby-trunk - Bug #6529]


git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@35976 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

ChangeLog

@@ -1,3 +1,8 @@
+Sat Jun  9 08:16:47 2012  Eric Hodel  <drbrain@segment7.net>
+
+	* doc/re.rdoc:  Completed wording in the description of the =~ operator.
+	  [ruby-trunk - Bug #6529]
+
 Sat Jun  9 08:09:38 2012  Eric Hodel  <drbrain@segment7.net>
 
 	* string.c (rb_str_start_with):  Removed "p" from start_with? examples

doc/re.rdoc

@@ -32,11 +32,15 @@ method.
 === <tt>=~</tt> operator
 
 <tt>=~</tt> is Ruby's basic pattern-matching operator.  When one operand is a
-regular expression and is a string (this operator is equivalently defined by
-Regexp and String). If a match is found, the operator returns index of first
-match in string, otherwise it returns +nil+.
+regular expression and the other is a string then the regular expression is
+used as a pattern to match against the string.  (This operator is equivalently
+defined by Regexp and String so the order of String and Regexp do not matter.
+Other classes may have different implementations of <tt>=~</tt>.)  If a match
+is found, the operator returns index of first match in string, otherwise it
+returns +nil+.
 
     /hay/ =~ 'haystack'   #=> 0
+    'haystack' =~ /hay/   #=> 0
     /a/   =~ 'haystack'   #=> 1
     /u/   =~ 'haystack'   #=> nil