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 <ijackson@chiark.greenend.org.uk>
  • Loading branch information
ijackson committed Jul 16, 2024
1 parent d7c7f5c commit 90d52cc
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 @@ -4,12 +4,15 @@
// the docs illustrate the usage in test functions
#![allow(clippy::test_attr_in_doctest)]

/// 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 90d52cc

Please sign in to comment.