* string.c: [DOC] Description of rb_str_equal [Fixes GH-375]

Based on a patch by @markijbema
  https://github.com/ruby/ruby/pull/375


git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@42417 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
This commit is contained in:
zzak 2013-08-07 00:02:17 +00:00
parent aecd5b67d5
commit aa66f59c97
2 changed files with 14 additions and 3 deletions

View file

@ -2400,9 +2400,14 @@ str_eql(const VALUE str1, const VALUE str2)
* str == obj -> true or false
* str === obj -> true or false
*
* Equality---If <i>obj</i> is not a <code>String</code>, returns
* <code>false</code>. Otherwise, returns <code>true</code> if <i>str</i>
* <code><=></code> <i>obj</i> returns zero.
* === Equality
*
* Returns whether +str+ == +obj+, similar to Object#==.
*
* If +obj+ is not an instance of String but responds to +to_str+, then the
* two strings are compared using case equality Object#===.
*
* Otherwise, returns similarly to String#eql?, comparing length and content.
*/
VALUE