Skip to content

[DOC] Tweaks for String#<< #13306

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#<< #13306

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
557d8a8
[DOC] Tweaks for String#<<
BurdetteLamar May 12, 2025
93d0e72
[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
33 changes: 19 additions & 14 deletions string.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4308,37 +4308,42 @@ rb_str_append_as_bytes(int argc, VALUE *argv, VALUE str)

/*
* call-seq:
* string << object -> string
* self << object -> self
*
* Concatenates +object+ to +self+ and returns +self+:
* Appends a string representation of +object+ to +self+;
* returns +self+.
*
* If +object+ is a string, appends it to +self+:
*
* s = 'foo'
* s << 'bar' # => "foobar"
* s # => "foobar"
*
* If +object+ is an Integer,
* the value is considered a codepoint and converted to a character before concatenation:
* If +object+ is an integer,
* its value is considered a codepoint;
* converts the value to a character before concatenating:
*
* s = 'foo'
* s << 33 # => "foo!"
*
* If that codepoint is not representable in the encoding of
* _string_, RangeError is raised.
* Additionally, if the codepoint is in range <tt>0..0xff</tt>
* and the encoding of +self+ is Encoding::US_ASCII,
* changes the encoding to Encoding::ASCII_8BIT:
*
* s = 'foo'.encode(Encoding::US_ASCII)
* s.encoding # => #<Encoding:US-ASCII>
* s << 0xff # => "foo\xFF"
* s.encoding # => #<Encoding:BINARY (ASCII-8BIT)>
*
* Raises RangeError if that codepoint is not representable in the encoding of +self+:
*
* s = 'foo'
* s.encoding # => <Encoding:UTF-8>
* s << 0x00110000 # 1114112 out of char range (RangeError)
* s = 'foo'.encode(Encoding::EUC_JP)
* s << 0x00800080 # invalid codepoint 0x800080 in EUC-JP (RangeError)
*
* If the encoding is US-ASCII and the codepoint is 0..0xff, _string_
* is automatically promoted to ASCII-8BIT.
*
* s = 'foo'.encode(Encoding::US_ASCII)
* s << 0xff
* s.encoding # => #<Encoding:BINARY (ASCII-8BIT)>
*
* Related: String#concat, which takes multiple arguments.
* Related: see {Modifying}[rdoc-ref:String@Modifying].
*/
VALUE
rb_str_concat(VALUE str1, VALUE str2)
Expand Down