amend panic docs

reflects the fact that, despite the use of expect, current code does not panic
coriolinus · Sep 19, 2023 · 1ab1d58 · 1ab1d58
1 parent 93f6fba
commit 1ab1d58
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/src/lib.rs b/src/lib.rs
@@ -498,9 +498,9 @@ where
     /// be worth experimenting to see which of the two methods is faster.
     ///
     /// [`most_common_ordered`]: Counter::most_common_ordered
-    /// 
+    ///
     /// # Panics
-    /// Panics if heap is empty
+    /// Preconditions ensure that the current implementation does not panic. 
     pub fn k_most_common_ordered(&self, k: usize) -> Vec<(T, N)> {
         use std::cmp::Reverse;