diff options
| author | Jason Zaugg <jzaugg@gmail.com> | 2014-10-01 20:10:24 +1000 |
|---|---|---|
| committer | Jason Zaugg <jzaugg@gmail.com> | 2014-10-01 20:10:24 +1000 |
| commit | 02d0dd0135f5721c37d9fcb7d0937ed3297676ea (patch) | |
| tree | d8bb802281a12e5de28d3df7c9d952a9774f1815 /src | |
| parent | 47b2dd9782719940f279caff39ad7d8a4d347404 (diff) | |
| parent | 6826a04c7d7ecb158ee92a267558dc261b233e00 (diff) | |
| download | scala-02d0dd0135f5721c37d9fcb7d0937ed3297676ea.tar.gz scala-02d0dd0135f5721c37d9fcb7d0937ed3297676ea.tar.bz2 scala-02d0dd0135f5721c37d9fcb7d0937ed3297676ea.zip | |
Merge pull request #4020 from Ichoran/issue/8624
SI-8624 PriorityQueue documentation is not clear enough
Diffstat (limited to 'src')
| -rw-r--r-- | src/library/scala/collection/mutable/PriorityQueue.scala | 5 |
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`. * |