summaryrefslogtreecommitdiff
path: root/include/ruby/internal
diff options
context:
space:
mode:
authorAlan Wu <[email protected]>2024-08-28 17:27:57 -0400
committerAlan Wu <[email protected]>2024-08-28 17:27:57 -0400
commit3fa5b4be195a84391e7cbde88b4c7d2e6fcf0e7c (patch)
treebc447a74d237650037e354bf2014666157e6c442 /include/ruby/internal
parentc3ffa7106b8cd89bdc85f579a8e27cde6b5539ab (diff)
[DOC] Mention rb_io_fdopen() takes ownership of the FD
Diffstat (limited to 'include/ruby/internal')
-rw-r--r--include/ruby/internal/intern/io.h2
1 files changed, 1 insertions, 1 deletions
diff --git a/include/ruby/internal/intern/io.h b/include/ruby/internal/intern/io.h
index 02c249723e..b9eb258cc1 100644
--- a/include/ruby/internal/intern/io.h
+++ b/include/ruby/internal/intern/io.h
@@ -385,7 +385,7 @@ VALUE rb_io_puts(int argc, const VALUE *argv, VALUE io);
* @param[in] fd Target file descriptor.
* @param[in] flags Flags, e.g. `O_CREAT|O_EXCL`
* @param[in] path The path of the file that backs `fd`, for diagnostics.
- * @return An allocated instance of ::rb_cIO.
+ * @return An allocated instance of ::rb_cIO with the autoclose flag set.
* @note Leave `path` NULL if you don't know.
*/
VALUE rb_io_fdopen(int fd, int flags, const char *path);