diff options
author | Lars Kanis <lars@greiz-reinsdorf.de> | 2022-03-12 13:06:46 +0100 |
---|---|---|
committer | Hiroshi SHIBATA <hsbt@ruby-lang.org> | 2023-03-01 16:02:11 +0900 |
commit | 47f8bf50e1410223731e2b442ad5a6b9ea1106b5 (patch) | |
tree | d6a53d432bbfdc350ed964e0129dbe2d6ac35577 /io.c | |
parent | 62b3bcba5ee422d7431f90567636155358234288 (diff) | |
download | ruby-47f8bf50e1410223731e2b442ad5a6b9ea1106b5.tar.gz |
[DOC] Clarify IO#autoclose impact on #close
Mention that autoclose changes the behavior of explicit close in addition to implicit close at IO finalization.
Diffstat (limited to 'io.c')
-rw-r--r-- | io.c | 12 |
1 files changed, 6 insertions, 6 deletions
@@ -9549,7 +9549,7 @@ rb_io_s_for_fd(int argc, VALUE *argv, VALUE klass) * ios.autoclose? -> true or false * * Returns +true+ if the underlying file descriptor of _ios_ will be - * closed automatically at its finalization, otherwise +false+. + * closed at its finalization or at calling #close, otherwise +false+. */ static VALUE @@ -9567,13 +9567,13 @@ rb_io_autoclose_p(VALUE io) * Sets auto-close flag. * * f = open("/dev/null") - * IO.for_fd(f.fileno) - * # ... - * f.gets # may cause Errno::EBADF + * IO.for_fd(f.fileno).close + * f.gets # raises Errno::EBADF * * f = open("/dev/null") - * IO.for_fd(f.fileno).autoclose = false - * # ... + * g = IO.for_fd(f.fileno) + * g.autoclose = false + * g.close * f.gets # won't cause Errno::EBADF */ |