Skip to content

Commit

Permalink
Clarify docs for TestError a little
Browse files Browse the repository at this point in the history
Signed-off-by: Ian Jackson <[email protected]>
  • Loading branch information
ijackson committed Jul 15, 2024
1 parent c360664 commit 2b16c16
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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 {}

Expand Down

0 comments on commit 2b16c16

Please sign in to comment.