ndarray-rand: document panics

bluss · bluss · commit e2af7ed84864 · 2016-03-19T23:11:37.000+01:00
diff --git a/ndarray-rand/src/lib.rs b/ndarray-rand/src/lib.rs
@@ -35,6 +35,8 @@ pub trait RandomExt<S, D>
     /// Create an array with shape `dim` with elements drawn from
     /// `distribution`  using the default rng.
     ///
+    /// ***Panics*** if the number of elements overflows usize.
+    ///
     /// ```
     /// extern crate rand;
     /// extern crate ndarray;
@@ -56,6 +58,8 @@ pub trait RandomExt<S, D>
 
     /// Create an array with shape `dim` with elements drawn from
     /// `distribution`, using a specific Rng `rng`.
+    ///
+    /// ***Panics*** if the number of elements overflows usize.
     fn random_using<IdS, R>(dim: D, distribution: IdS, rng: &mut R) -> ArrayBase<S, D>
         where IdS: IndependentSample<S::Elem>,
               R: Rng;
