Skip to content

[DOC] Tweaks for String#== #13323

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
peterzhu2118 merged 2 commits into from
May 14, 2025
Merged

[DOC] Tweaks for String#== #13323

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
744740d
[DOC] Tweaks for String#==
BurdetteLamar May 13, 2025
40adb9e
[DOC] Tweaks for String==
BurdetteLamar May 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 15 additions & 8 deletions string.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4551,22 +4551,29 @@ rb_str_cmp(VALUE str1, VALUE str2)

/*
* call-seq:
* string == object -> true or false
* string === object -> true or false
* self == object -> true or false
*
* Returns +true+ if +object+ has the same length and content;
* as +self+; +false+ otherwise:
* Returns whether +object+ is equal to +self+.
*
* When +object+ is a string, returns whether +object+ has the same length and content as +self+:
*
* s = 'foo'
* s == 'foo' # => true
* s == 'foo' # => true
* s == 'food' # => false
* s == 'FOO' # => false
* s == 'FOO' # => false
*
* Returns +false+ if the two strings' encodings are not compatible:
*
* "\u{e4 f6 fc}".encode(Encoding::ISO_8859_1) == ("\u{c4 d6 dc}") # => false
*
* If +object+ is not an instance of +String+ but responds to +to_str+, then the
* two strings are compared using <code>object.==</code>.
* When +object+ is not a string:
*
* - If +object+ responds to method <tt>to_str</tt>,
* <tt>object == self</tt> is called and its return value is returned.
* - If +object+ does not respond to <tt>to_str</tt>,
* +false+ is returned.
*
* Related: {Comparing}[rdoc-ref:String@Comparing].
*/

VALUE
Expand Down