Skip to content

[DOC] Tweaks for StringIO.open #146

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
kou merged 2 commits into from
Oct 23, 2025
Merged

[DOC] Tweaks for StringIO.open #146

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2d47d21
[DOC] TWeaks for StringIO.open
BurdetteLamar Oct 21, 2025
f2a5499
[DOC] Tweaks for StringIO.open
BurdetteLamar Oct 22, 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
17 changes: 7 additions & 10 deletions ext/stringio/stringio.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -370,23 +370,20 @@ strio_finalize(VALUE self)

/*
* call-seq:
* StringIO.open(string = '', mode = 'r+') {|strio| ... }
* StringIO.open(string = '', mode = 'r+') -> new_stringio
* StringIO.open(string = '', mode = 'r+') {|strio| ... } -> object
*
* Note that +mode+ defaults to <tt>'r'</tt> if +string+ is frozen.
*
* Creates a new \StringIO instance formed from +string+ and +mode+;
* see {Access Modes}[rdoc-ref:File@Access+Modes].
* Creates new \StringIO instance by calling <tt>StringIO.new(string, mode)</tt>.
*
* With no block, returns the new instance:
* With no block given, returns the new instance:
*
* strio = StringIO.open # => #<StringIO>
*
* With a block, calls the block with the new instance
* With a block given, calls the block with the new instance
* and returns the block's value;
* closes the instance on block exit.
* closes the instance on block exit:
*
* StringIO.open {|strio| p strio }
* # => #<StringIO>
* StringIO.open('foo') {|strio| strio.string.upcase } # => "FOO"
*
* Related: StringIO.new.
*/
Expand Down