diff options
author | zzak <zzak@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2013-08-07 00:02:17 +0000 |
---|---|---|
committer | zzak <zzak@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2013-08-07 00:02:17 +0000 |
commit | aa66f59c97bfdf53e7232d8cf9aa5bd2335666df (patch) | |
tree | e9d3dcc6eae8a3a5285f114ba47b281cfd4563f9 | |
parent | aecd5b67d50705511e565ac0dc2290c27279fda4 (diff) | |
download | ruby-aa66f59c97bfdf53e7232d8cf9aa5bd2335666df.tar.gz |
* 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
-rw-r--r-- | ChangeLog | 6 | ||||
-rw-r--r-- | string.c | 11 |
2 files changed, 14 insertions, 3 deletions
@@ -1,3 +1,9 @@ +Wed Aug 7 09:00:24 2013 Zachary Scott <e@zzak.io> + + * string.c: [DOC] Description of rb_str_equal [Fixes GH-375] + Based on a patch by @markijbema + https://github.com/ruby/ruby/pull/375 + Wed Aug 7 08:30:38 2013 Zachary Scott <e@zzak.io> * ext/openssl/ossl_hmac.c: [DOC] Documentation for OpenSSL::HMAC @@ -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 |