Suggest use try_from_bisector over from_bisector

foresterre · May 25, 2022 · 3b9bf5f · 3b9bf5f
1 parent 38b42a0
commit 3b9bf5f
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/lib.rs b/src/lib.rs
@@ -199,6 +199,8 @@ impl Indices {
     ///
     /// NB: The slice given to [`Bisector`] **must not be empty**.
     ///
+    /// Consider using the fallible function [`Indices::try_from_bisector`] when possible.
+    ///
     /// ### Undefined behaviour
     ///
     /// If the slice given to [`Bisector`] is empty, the resulting behaviour may not be as expected.
@@ -216,6 +218,7 @@ impl Indices {
     /// set to the `right` index will underflow, resulting in undefined behaviour.
     ///
     /// [`Bisector`]: crate::Bisector
+    /// [`Indices::try_from_bisector`]: crate::Indices::try_from_bisector
     pub fn from_bisector<T>(bisector: &Bisector<T>) -> Self {
         Self {
             left: 0,