doc: document Gen::size

PR #255
BurntSushi · Jan 22, 2020 · 4a300c5 · 4a300c5
1 parent d771da1
commit 4a300c5
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/arbitrary.rs b/src/arbitrary.rs
@@ -30,6 +30,10 @@ use rand::{self, Rng, RngCore};
 /// A value with type satisfying the `Gen` trait can be constructed with the
 /// `gen` function in this crate.
 pub trait Gen: RngCore {
+    /// Returns the `size` parameter used by this `Gen`, which controls the size
+    /// of random values generated. For example, it specifies the maximum length
+    /// of a randomly generated vector and also will specify the maximum
+    /// magnitude of a randomly generated number.
     fn size(&self) -> usize;
 }