[ruby/stringio] [DOC] Tweaks for StringIO#close_read

BurdetteLamar · matzbot · commit fcf8b10b3c67 · 2025-10-27T01:02:38.000Z
(ruby/stringio#149) ruby/stringio@11995db341
diff --git a/ext/stringio/stringio.c b/ext/stringio/stringio.c
@@ -572,9 +572,16 @@ strio_close(VALUE self)
  * call-seq:
  *   close_read -> nil
  *
- * Closes +self+ for reading; closed-write setting remains unchanged.
+ * Closes +self+ for reading;
+ * closed-write setting remains unchanged;
+ * returns +nil+:
  *
- * Raises IOError if reading is attempted.
+ *   strio = StringIO.new
+ *   strio.closed_read?  # => false
+ *   strio.close_read    # => nil
+ *   strio.closed_read?  # => true
+ *   strio.closed_write? # => false
+ *   strio.read          # Raises IOError: not opened for reading
  *
  * Related: StringIO#close, StringIO#close_write.
  */

Original file line number	Diff line number	Diff line change
`@@ -572,9 +572,16 @@ strio_close(VALUE self)`
`572`	`572`	`* call-seq:`
`573`	`573`	`* close_read -> nil`
`574`	`574`	`*`
`575`		`- * Closes +self+ for reading; closed-write setting remains unchanged.`
	`575`	`+ * Closes +self+ for reading;`
	`576`	`+ * closed-write setting remains unchanged;`
	`577`	`+ * returns +nil+:`
`576`	`578`	`*`
`577`		`- * Raises IOError if reading is attempted.`
	`579`	`+ * strio = StringIO.new`
	`580`	`+ * strio.closed_read? # => false`
	`581`	`+ * strio.close_read # => nil`
	`582`	`+ * strio.closed_read? # => true`
	`583`	`+ * strio.closed_write? # => false`
	`584`	`+ * strio.read # Raises IOError: not opened for reading`
`578`	`585`	`*`
`579`	`586`	`* Related: StringIO#close, StringIO#close_write.`
`580`	`587`	`*/`