Skip to content

Commit 7ded426

Browse files
[DOC] Tweaks for StringIO.closed_read? (#152)
1 parent 3e9d576 commit 7ded426

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
@@ -637,7 +637,14 @@ strio_closed(VALUE self)
637637
* call-seq:
638638
* closed_read? -> true or false
639639
*
640-
* Returns +true+ if +self+ is closed for reading, +false+ otherwise.
640+
* Returns whether +self+ is closed for reading:
641+
*
642+
* strio = StringIO.new
643+
* strio.closed_read? # => false
644+
* strio.close_read
645+
* strio.closed_read? # => true
646+
*
647+
* Related: StringIO#closed?, StringIO#closed_write?, StringIO#close_read.
641648
*/
642649
static VALUE
643650
strio_closed_read(VALUE self)

0 commit comments

Comments
 (0)