summaryrefslogtreecommitdiff
path: root/thread_sync.rb
diff options
context:
space:
mode:
Diffstat (limited to 'thread_sync.rb')
-rw-r--r--thread_sync.rb6
1 files changed, 3 insertions, 3 deletions
diff --git a/thread_sync.rb b/thread_sync.rb
index 7e4c341ad0..f8fa69900b 100644
--- a/thread_sync.rb
+++ b/thread_sync.rb
@@ -10,7 +10,7 @@ class Thread
# +ThreadError+ is raised.
#
# If +timeout+ seconds have passed and no data is available +nil+ is
- # returned.
+ # returned. If +timeout+ is +0+ it returns immediately.
def pop(non_block = false, timeout: nil)
if non_block && timeout
raise ArgumentError, "can't set a timeout if non_block is enabled"
@@ -32,7 +32,7 @@ class Thread
# suspended, and +ThreadError+ is raised.
#
# If +timeout+ seconds have passed and no data is available +nil+ is
- # returned.
+ # returned. If +timeout+ is +0+ it returns immediately.
def pop(non_block = false, timeout: nil)
if non_block && timeout
raise ArgumentError, "can't set a timeout if non_block is enabled"
@@ -54,7 +54,7 @@ class Thread
# thread isn't suspended, and +ThreadError+ is raised.
#
# If +timeout+ seconds have passed and no space is available +nil+ is
- # returned.
+ # returned. If +timeout+ is +0+ it returns immediately.
# Otherwise it returns +self+.
def push(object, non_block = false, timeout: nil)
if non_block && timeout