[#57574] [ruby-trunk - Feature #8976][Open] file-scope freeze_string directive — "akr (Akira Tanaka)" <akr@...>

70 messages 2013/10/02

[#57579] [ruby-trunk - Feature #8977][Open] String#frozen that takes advantage of the deduping — "sam.saffron (Sam Saffron)" <sam.saffron@...>

25 messages 2013/10/02

[#57679] [ruby-trunk - Feature #8987][Open] map/collect extension which handles arguments — "sowieso (So Wieso)" <sowieso@...>

16 messages 2013/10/05

[#57705] [ruby-trunk - Feature #8992][Open] Use String#freeze and compiler tricks to replace "str"f suffix — "headius (Charles Nutter)" <headius@...>

43 messages 2013/10/07

[#57727] [ruby-trunk - Feature #8998][Open] string keys for hash literals should use fstrings — "normalperson (Eric Wong)" <normalperson@...>

17 messages 2013/10/08

[#57771] [ruby-trunk - Bug #9008][Open] TestProcess#test_clock_getres_constants and TestProcess#test_clock_gettime_constants fails on ARM — "vo.x (Vit Ondruch)" <v.ondruch@...>

15 messages 2013/10/09

[#57888] [ruby-trunk - Feature #9025][Open] Clarify the error message when calling a method with the wrong number of arguments — Nerian (Gonzalo Rodríguez) <siotopo@...>

11 messages 2013/10/15

[#57993] [ruby-trunk - Feature #9047][Open] Alternate hash key syntax for symbols — "jamonholmgren (Jamon Holmgren)" <jamon@...>

13 messages 2013/10/23

[#58007] [ruby-trunk - Feature #9049][Open] Shorthands (a:b, *) for inclusive indexing — "mohawkjohn (John Woods)" <john.o.woods@...>

25 messages 2013/10/24

[#58033] [ruby-trunk - Bug #9053][Open] SSL Issue with Ruby 2.0.0 — "tisba (Sebastian Cohnen)" <ruby-lang@...>

16 messages 2013/10/25

[#58080] [ruby-trunk - Feature #9064][Open] Add support for packages, like in Java — "rosenfeld (Rodrigo Rosenfeld Rosas)" <rr.rosas@...>

23 messages 2013/10/30

[ruby-core:57681] [ruby-trunk - Bug #8988][Open] [DOC] fix incorrect documentation for SizedQueue

From: "jackdanger (Jack Danger)" <ruby@...>
Date: 2013-10-05 15:58:36 UTC
List: ruby-core #57681
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/

In This Thread

Prev Next