Document the type NoError

Chris00 · Dec 25, 2023 · 8604970 · 8604970
1 parent dc19eb4
commit 8604970
Showing 1 changed file with 2 additions and 0 deletions.
diff --git 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.