diff --git a/src/lib.rs b/src/lib.rs index b05ca06..2bf4bab 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -2,12 +2,15 @@ #![deny(missing_debug_implementations)] #![deny(missing_docs)] -/// Error with a stacktrace +/// Error, but one which immediately panics with a stacktrace +/// +/// Usually used via [`TestResult`]. /// /// Any other type of error can be converted to this one but the /// conversion will always panic. /// -/// This type is useful only in unit tests and cannot be directly instantiated. +/// This type is useful only in unit tests. +/// It cannot be instantiated: no values of this type can ever exist. #[derive(Debug)] pub enum TestError {}