diff options
| author | apatniv <apatniv@gmail.com> | 2022-01-23 21:31:29 -0500 |
|---|---|---|
| committer | git <svn-admin@ruby-lang.org> | 2022-01-24 12:12:15 +0900 |
| commit | e7b573e5768956b110c25b2cab02a889f2e8cc8e (patch) | |
| tree | 12ec5e7fba3c0b64b26c42f2a1b5a0173a884b54 | |
| parent | c6a19b77a20ec2292f0cc70050131061f6d29c68 (diff) | |
[ruby/io-wait] Document mandatory require for using io/wait methods
https://github.com/ruby/io-wait/commit/2beb05bd48
| -rw-r--r-- | ext/io/wait/wait.c | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/ext/io/wait/wait.c b/ext/io/wait/wait.c index 8f0d16e168..74a1b49ee5 100644 --- a/ext/io/wait/wait.c +++ b/ext/io/wait/wait.c @@ -77,6 +77,8 @@ wait_for_single_fd(rb_io_t *fptr, int events, struct timeval *tv) * * Returns number of bytes that can be read without blocking. * Returns zero if no information available. + * + * You must require 'io/wait' to use this method. */ static VALUE @@ -122,6 +124,8 @@ io_wait_event(VALUE io, int event, VALUE timeout) * io.ready? -> true or false * * Returns +true+ if input available without blocking, or +false+. + * + * You must require 'io/wait' to use this method. */ static VALUE @@ -154,6 +158,8 @@ io_ready_p(VALUE io) * Waits until IO is readable and returns +true+, or * +false+ when times out. * Returns +true+ immediately when buffered data is available. + * + * You must require 'io/wait' to use this method. */ static VALUE @@ -193,6 +199,8 @@ io_wait_readable(int argc, VALUE *argv, VALUE io) * * Waits until IO is writable and returns +true+ or * +false+ when times out. + * + * You must require 'io/wait' to use this method. */ static VALUE io_wait_writable(int argc, VALUE *argv, VALUE io) @@ -228,6 +236,8 @@ io_wait_writable(int argc, VALUE *argv, VALUE io) * * Waits until IO is priority and returns +true+ or * +false+ when times out. + * + * You must require 'io/wait' to use this method. */ static VALUE io_wait_priority(int argc, VALUE *argv, VALUE io) @@ -295,6 +305,8 @@ wait_mode_sym(VALUE mode) * * Optional parameter +mode+ is one of +:read+, +:write+, or * +:read_write+. + * + * You must require 'io/wait' to use this method. */ static VALUE |