Merge pull request scala#4020 from Ichoran/issue/8624

retronym · retronym · commit 02d0dd0135f5 · 2014-10-01T20:10:24.000+10:00
SI-8624 PriorityQueue documentation is not clear enough
diff --git a/src/library/scala/collection/mutable/PriorityQueue.scala b/src/library/scala/collection/mutable/PriorityQueue.scala
@@ -16,6 +16,11 @@ import generic._
  *  To prioritize elements of type A there must be an implicit
  *  Ordering[A] available at creation.
  *
+ *  Only the `dequeue` and `dequeueAll` methods will return methods in priority
+ *  order (while removing elements from the heap).  Standard collection methods
+ *  including `drop` and `iterator` will remove or traverse the heap in whichever
+ *  order seems most convenient.
+ *
  *  @tparam A    type of the elements in this priority queue.
  *  @param ord   implicit ordering used to compare the elements of type `A`.
  *

Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,11 @@ import generic._`
`16`	`16`	`* To prioritize elements of type A there must be an implicit`
`17`	`17`	`* Ordering[A] available at creation.`
`18`	`18`	`*`
	`19`	+ * Only the `dequeue` and `dequeueAll` methods will return methods in priority
	`20`	`+ * order (while removing elements from the heap). Standard collection methods`
	`21`	+ * including `drop` and `iterator` will remove or traverse the heap in whichever
	`22`	`+ * order seems most convenient.`
	`23`	`+ *`
`19`	`24`	`* @tparam A type of the elements in this priority queue.`
`20`	`25`	* @param ord implicit ordering used to compare the elements of type `A`.
`21`	`26`	`*`