[DOC] Mention rb_io_fdopen() takes ownership of the FD

XrXr · Aug 28, 2024 · 3fa5b4b · 3fa5b4b
1 parent c3ffa71
commit 3fa5b4b
Showing 1 changed file with 1 addition and 1 deletion.
diff --git 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);