Tweaks for StringIO#close_read

BurdetteLamar · BurdetteLamar · commit 0ebb66541df6 · 2025-10-25T21:37:46.000+01:00
diff --git a/ext/stringio/stringio.c b/ext/stringio/stringio.c
@@ -572,9 +572,14 @@ strio_close(VALUE self)
  * call-seq:
  *   close_read -> nil
  *
- * Closes +self+ for reading; closed-write setting remains unchanged.
+ * Closes +self+ for reading; 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,14 @@ 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; returns +nil+:`
`576`	`576`	`*`
`577`		`- * Raises IOError if reading is attempted.`
	`577`	`+ * strio = StringIO.new`
	`578`	`+ * strio.closed_read? # => false`
	`579`	`+ * strio.close_read # => nil`
	`580`	`+ * strio.closed_read? # => true`
	`581`	`+ * strio.closed_write? # => false`
	`582`	`+ * strio.read # Raises IOError: not opened for reading`
`578`	`583`	`*`
`579`	`584`	`* Related: StringIO#close, StringIO#close_write.`
`580`	`585`	`*/`