From 656ff88d8fee9d47f80450da23bea75bfd4cc25e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Johanna=20S=C3=B6rng=C3=A5rd?= <jsorngard@gmail.com>
Date: Fri, 10 May 2024 09:50:32 +0200
Subject: [PATCH] Add docstrings to SieveError variants

---
 src/sieving.rs | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/src/sieving.rs b/src/sieving.rs
index 563ba7c..1e86aa3 100644
--- 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,
 }