diff options
author | Burdette Lamar <BurdetteLamar@Yahoo.com> | 2022-10-29 14:47:16 -0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-10-29 14:47:16 -0500 |
commit | 91c28ab2ee58f9b5da33dc566a4c263449b8520f (patch) | |
tree | d9e37e8f7a0b68cdc6206d2807b3c0994ee3179c /doc | |
parent | 572cd10a868b726f8a71cf7ffe2b616e22c273ad (diff) |
[DOC] Enhanced RDOc for IO (#6642)
In io.c treats:
#close
#close_read
#close_write
#closed
Notes
Notes:
Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/io_streams.rdoc | 11 |
1 files changed, 5 insertions, 6 deletions
diff --git a/doc/io_streams.rdoc b/doc/io_streams.rdoc index 3ee8592687..c8ce9991cf 100644 --- a/doc/io_streams.rdoc +++ b/doc/io_streams.rdoc @@ -189,14 +189,13 @@ The relevant methods: A new \IO stream may be open for reading, open for writing, or both. -You can close a stream using these methods: +A stream is automatically closed when claimed by the garbage collector. -- IO#close: Closes the stream for both reading and writing. -- IO#close_read (not in \ARGF): Closes the stream for reading. -- IO#close_write (not in \ARGF): Closes the stream for writing. - -You can query whether a stream is closed using this method: +Attempted reading or writing on a closed stream raises an exception. +- IO#close: Closes the stream for both reading and writing. +- IO#close_read: Closes the stream for reading; not in ARGF. +- IO#close_write: Closes the stream for writing; not in ARGF. - IO#closed?: Returns whether the stream is closed. ==== End-of-Stream |