commit fab149dcd26af3746dac75bcae9ef1e6991310aa
author Jeffrey Burdges <burdges@gnunet.org> Sun Jan 29 17:53:05 2017 +0100
committer Jeffrey Burdges <burdges@gnunet.org> Sun Jan 29 17:53:05 2017 +0100
tree 50b68a17a26aa3c2397caa9285d6fd3601f2529b
parent 4402c903adcf65085012d9a3597b9eebaf6ef3df

Add note that shuffle uses Fisher–Yates shuffle which is unbiased

src/lib.rs

diff --git a/src/lib.rs b/src/lib.rs
index 955a3c8..0eccca9 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -534,6 +534,9 @@
 
     /// Shuffle a mutable slice in place.
     ///
+    /// This applies Durstenfeld's algorithm for the [Fisher–Yates shuffle](https://en.wikipedia.org/wiki/Fisher%E2%80%93Yates_shuffle#The_modern_algorithm) 
+    /// which produces an unbiased permutation.
+    ///
     /// # Example
     ///
     /// ```rust