1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00

[DOC] Improve Thread::Queue.new docs [ci skip]

This commit is contained in:
Victor Shepelev 2021-12-15 04:25:33 +02:00 committed by GitHub
parent ac5d6faea8
commit 0fcc58a18c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
Notes: git 2021-12-15 11:25:53 +09:00
Merged: https://github.com/ruby/ruby/pull/5273

Merged-By: nobu <nobu@ruby-lang.org>

View file

@ -838,14 +838,26 @@ queue_closed_result(VALUE self, struct rb_queue *q)
/*
* Document-method: Queue::new
*
* Creates a new queue instance, optionally using the contents of an Enumerable
* call-seq:
* Thread::Queue.new -> empty_queue
* Thread::Queue.new(enumerable) -> queue
*
* Creates a new queue instance, optionally using the contents of an +enumerable+
* for its initial state.
*
* Example:
* Example:
*
* q = Thread::Queue.new
* q = Thread::Queue.new([a, b, c])
* q = Thread::Queue.new(items)
* #=> #<Thread::Queue:0x00007ff7501110d0>
* q.empty?
* #=> true
*
* q = Thread::Queue.new([1, 2, 3])
* #=> #<Thread::Queue:0x00007ff7500ec500>
* q.empty?
* #=> false
* q.pop
* #=> 1
*/
static VALUE