summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
Diffstat (limited to 'src')
-rw-r--r--src/library/scala/collection/mutable/PriorityQueue.scala5
1 files changed, 5 insertions, 0 deletions
diff --git a/src/library/scala/collection/mutable/PriorityQueue.scala b/src/library/scala/collection/mutable/PriorityQueue.scala
index b949bec48a..a6e538528a 100644
--- 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`.
*