[DOC] Tweaks for StringIO#close_write

BurdetteLamar · BurdetteLamar · commit 90309d1a57c3 · 2025-10-25T21:45:52.000+01:00
diff --git a/ext/stringio/stringio.c b/ext/stringio/stringio.c
@@ -593,9 +593,14 @@ strio_close_read(VALUE self)
  * call-seq:
  *   close_write -> nil
  *
- * Closes +self+ for writing; closed-read setting remains unchanged.
+ * Closes +self+ for writing; returns +nil+:
  *
- * Raises IOError if writing is attempted.
+ *   strio = StringIO.new
+ *   strio.closed_write? # => false
+ *   strio.close_write   # => nil
+ *   strio.closed_write? # => true
+ *   strio.closed_read?  # => false
+ *   strio.write('foo')  # Raises IOError: not opened for writing
  *
  * Related: StringIO#close, StringIO#close_read.
  */

Original file line number	Diff line number	Diff line change
`@@ -593,9 +593,14 @@ strio_close_read(VALUE self)`
`593`	`593`	`* call-seq:`
`594`	`594`	`* close_write -> nil`
`595`	`595`	`*`
`596`		`- * Closes +self+ for writing; closed-read setting remains unchanged.`
	`596`	`+ * Closes +self+ for writing; returns +nil+:`
`597`	`597`	`*`
`598`		`- * Raises IOError if writing is attempted.`
	`598`	`+ * strio = StringIO.new`
	`599`	`+ * strio.closed_write? # => false`
	`600`	`+ * strio.close_write # => nil`
	`601`	`+ * strio.closed_write? # => true`
	`602`	`+ * strio.closed_read? # => false`
	`603`	`+ * strio.write('foo') # Raises IOError: not opened for writing`
`599`	`604`	`*`
`600`	`605`	`* Related: StringIO#close, StringIO#close_read.`
`601`	`606`	`*/`