Add docstrings to SieveError variants

JSorngard · May 10, 2024 · 656ff88 · 656ff88
1 parent 59ddee2
commit 656ff88
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/sieving.rs b/src/sieving.rs
@@ -218,8 +218,11 @@ pub const fn sieve<const N: usize>() -> [bool; N] {
 /// is invalid.
 #[derive(Debug, Clone, Copy, PartialEq, Eq)]
 pub enum SieveError {
+    /// The limit was less than or equal to `N` (for `sieve_lt`).
     TooSmallLimit,
+    /// `limit` or `limit + MEM` was larger than or equal to `MEM`^2.
     NotEnoughMemory,
+    /// `limit + MEM` did not fit in a `u64`.
     TotalDoesntFitU64,
 }