From: "jackdanger (Jack Danger)" <ruby@...>
Date: 2013-10-06T00:58:36+09:00
Subject: [ruby-core:57681] [ruby-trunk - Bug #8988][Open] [DOC] fix	incorrect documentation for SizedQueue


Issue #8988 has been reported by jackdanger (Jack Danger).

----------------------------------------
Bug #8988: [DOC] fix incorrect documentation for SizedQueue
https://bugs.ruby-lang.org/issues/8988

Author: jackdanger (Jack Danger)
Status: Open
Priority: Low
Assignee: zzak (Zachary Scott)
Category: doc
Target version: current: 2.1.0
ruby -v: ruby 2.1.0dev (2013-10-05 trunk 43149) [x86_64-darwin12.4.0]
Backport: 1.9.3: UNKNOWN, 2.0.0: UNKNOWN


The SizedQueue documentation was incorrect for both SizedQueue#pop and SizedQueue#num_waiting. This patch adds correct documentation using language that is very similar to Queue#pop and Queue#num_waiting.

  * Document-method: pop
  * call_seq: pop(non_block=false)
  *
- * Returns the number of threads waiting on the queue.
+ * Retrieves data from the queue. If the queue is empty the calling thread is
+ * suspended until data is pushed onto the queue. If +non_block+ is true the
+ * thread isn't suspended and an exception is raised.
  */
 
- * Document-method: pop
- * call_seq: pop(non_block=false)
+ * Document-method: num_waiting
+ * call_seq: num_waiting
  *
  * Returns the number of threads waiting on the queue.
  */



-- 
http://bugs.ruby-lang.org/