summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorSamuel Williams <samuel.williams@oriontransfer.co.nz>2022-10-08 14:02:34 +1300
committerGitHub <noreply@github.com>2022-10-08 14:02:34 +1300
commit844a9dff887f0af075c0c50020f98a45a1528d14 (patch)
tree141cdd31cc6c083059939e6fb688a608a27bfe2e /include
parent5b3079a8a5f66859c8d80ad55b5424c7c1877443 (diff)
Try `nil` as default for 'default timeout'. (#6509)
Notes
Notes: Merged-By: ioquatix <samuel@codeotaku.com>
Diffstat (limited to 'include')
-rw-r--r--include/ruby/io.h8
1 files changed, 4 insertions, 4 deletions
diff --git a/include/ruby/io.h b/include/ruby/io.h
index bb3bb9cd53..88029b1bb9 100644
--- a/include/ruby/io.h
+++ b/include/ruby/io.h
@@ -59,7 +59,7 @@
#define RUBY_IO_WAIT_METHODS
// Used as the default timeout argument to `rb_io_wait` to use the `IO#timeout` value.
-#define RUBY_IO_TIMEOUT_DEFAULT Qundef
+#define RUBY_IO_TIMEOUT_DEFAULT Qnil
RBIMPL_SYMBOL_EXPORT_BEGIN()
@@ -881,14 +881,14 @@ VALUE rb_io_set_timeout(VALUE io, VALUE timeout);
* here is a Ruby level integer, which is an OR-ed value of `IO::READABLE`,
* `IO::WRITable`, and `IO::PRIORITY`.
*
- * If timeout is `Qundef`, it will use the default timeout as given by
+ * If timeout is `Qnil`, it will use the default timeout as given by
* `rb_io_timeout(io)`.
*
* @param[in] io An IO object to wait.
* @param[in] events See above.
* @param[in] timeout Time, or numeric seconds since UNIX epoch.
- * If Qnil, wait forever. If Qundef, use the
- * default timeout.
+ * If Qnil, use the default timeout. If Qfalse
+ * or Qundef, wait forever.
* @exception rb_eIOError `io` is not open.
* @exception rb_eRangeError `timeout` is out of range.
* @exception rb_eSystemCallError `select(2)` failed for some reason.