Generator will not actually panic

allenap · Sep 23, 2023 · 882d208 · 882d208
1 parent 4c31acb
commit 882d208
Showing 1 changed file with 1 addition and 2 deletions.
diff --git a/src/lib.rs b/src/lib.rs
@@ -242,8 +242,7 @@ impl<'a> Petnames<'a> {
     /// Calculate the cardinality of this `Petnames`.
     ///
     /// If this is low, names may be repeated by the generator with a higher
-    /// frequency than your use-case may allow. If it is 0 (zero) the generator
-    /// will panic (unless `words` is also zero).
+    /// frequency than your use-case may allow.
     ///
     /// This can saturate. If the total possible combinations of words exceeds
     /// `u128::MAX` then this will return `u128::MAX`.