From 86049707b7e2bbcbd8710eea83c5112e1d183caf Mon Sep 17 00:00:00 2001
From: Christophe Troestler <Christophe.Troestler@umons.ac.be>
Date: Tue, 26 Dec 2023 00:26:06 +0100
Subject: [PATCH] Document the type `NoError`

---
 src/lib.rs | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/src/lib.rs b/src/lib.rs
index 7be79d1..0bf13ad 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -55,9 +55,11 @@ use std::{
 };
 
 #[cfg(feature = "nightly")]
+/// Type indicating that no error is raised by the function.
 pub type NoError = !;
 #[cfg(not(feature = "nightly"))]
 #[derive(Debug)]
+/// Type indicating that no error is raised by the function.
 pub enum NoError {}
 
 /// Errors that may be returned by the root finding methods.