Skip to content

Commit 947e5ba

Browse files
BurdetteLamarkou
authored andcommitted
[ruby/stringio] [DOC] Tweaks for StringIO.closed_write?
(ruby/stringio#153) ruby/stringio@3e9d576441 Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
1 parent 52ea222 commit 947e5ba

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

ext/stringio/stringio.c

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -651,7 +651,14 @@ strio_closed_read(VALUE self)
651651
* call-seq:
652652
* closed_write? -> true or false
653653
*
654-
* Returns +true+ if +self+ is closed for writing, +false+ otherwise.
654+
* Returns whether +self+ is closed for writing:
655+
*
656+
* strio = StringIO.new
657+
* strio.closed_write? # => false
658+
* strio.close_write
659+
* strio.closed_write? # => true
660+
*
661+
* Related: StringIO#close_write, StringIO#closed?, StringIO#closed_read?.
655662
*/
656663
static VALUE
657664
strio_closed_write(VALUE self)

0 commit comments

Comments
 (0)