From 3d04cb36882280c44d24824df5cc0f349552d20f Mon Sep 17 00:00:00 2001 From: Steve Klabnik Date: Sun, 22 Mar 2015 15:21:29 -0400 Subject: [PATCH] Note order of BinaryHeap::drain Fixes #23564 --- src/libcollections/binary_heap.rs | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/libcollections/binary_heap.rs b/src/libcollections/binary_heap.rs index 11c8656c994b2..9d896a057c0b9 100644 --- a/src/libcollections/binary_heap.rs +++ b/src/libcollections/binary_heap.rs @@ -555,6 +555,8 @@ impl BinaryHeap { 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")]