about summary refs log tree commit diff
diff options
context:
space:
mode:
authorSteve Klabnik <steve@steveklabnik.com>2015-03-22 15:21:29 -0400
committerSteve Klabnik <steve@steveklabnik.com>2015-03-22 15:21:32 -0400
commit3d04cb36882280c44d24824df5cc0f349552d20f (patch)
treed411b233a78da88f78c24f50985def69f12c436c
parentecf8c64e1b1b60f228f0c472c0b0dab4a5b5aa61 (diff)
downloadrust-3d04cb36882280c44d24824df5cc0f349552d20f.tar.gz
rust-3d04cb36882280c44d24824df5cc0f349552d20f.zip
Note order of BinaryHeap::drain
Fixes #23564
-rw-r--r--src/libcollections/binary_heap.rs2
1 files changed, 2 insertions, 0 deletions
diff --git a/src/libcollections/binary_heap.rs b/src/libcollections/binary_heap.rs
index 11c8656c994..9d896a057c0 100644
--- a/src/libcollections/binary_heap.rs
+++ b/src/libcollections/binary_heap.rs
@@ -555,6 +555,8 @@ impl<T: Ord> BinaryHeap<T> {
     pub fn is_empty(&self) -> bool { self.len() == 0 }
 
     /// Clears the binary heap, returning an iterator over the removed elements.
+    ///
+    /// The elements are removed in arbitrary order.
     #[inline]
     #[unstable(feature = "collections",
                reason = "matches collection reform specification, waiting for dust to settle")]