diff options
author | kudojp <heyjudejudejude1968@gmail.com> | 2023-09-09 15:50:21 +0900 |
---|---|---|
committer | Nobuyoshi Nakada <nobu@ruby-lang.org> | 2023-09-10 19:39:28 +0900 |
commit | 0e49f8173a854bfa826c7b772d6fd990f6c75d0c (patch) | |
tree | 25a3b783b0aef326a83a604e93a44d42a59604a2 | |
parent | b926ac51ccce215674dd945735a5162ef7d5be8a (diff) |
[DOC] Fix method docs of scheduler#io_read and scheduler#io_write
Each of Fiber::Scheduler#io_read and io_write takes the "offset" as the fourth argument, which is not doucmented.
Notes
Notes:
Merged: https://github.com/ruby/ruby/pull/8407
-rw-r--r-- | scheduler.c | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/scheduler.c b/scheduler.c index 866e53993f..022e8401e0 100644 --- a/scheduler.c +++ b/scheduler.c @@ -458,7 +458,7 @@ VALUE rb_fiber_scheduler_io_selectv(VALUE scheduler, int argc, VALUE *argv) /* * Document-method: Fiber::Scheduler#io_read - * call-seq: io_read(io, buffer, length) -> read length or -errno + * call-seq: io_read(io, buffer, length, offset) -> read length or -errno * * Invoked by IO#read or IO#Buffer.read to read +length+ bytes from +io+ into a * specified +buffer+ (see IO::Buffer) at the given +offset+. @@ -518,7 +518,7 @@ rb_fiber_scheduler_io_pread(VALUE scheduler, VALUE io, rb_off_t from, VALUE buff /* * Document-method: Scheduler#io_write - * call-seq: io_write(io, buffer, length) -> written length or -errno + * call-seq: io_write(io, buffer, length, offset) -> written length or -errno * * Invoked by IO#write or IO::Buffer#write to write +length+ bytes to +io+ from * from a specified +buffer+ (see IO::Buffer) at the given +offset+. |