From 5a2913e90628cf1c7e4ec6b105251cfba3c4797d Mon Sep 17 00:00:00 2001
From: Ian Jackson <ijackson@chiark.greenend.org.uk>
Date: Mon, 15 Jul 2024 18:19:56 +0100
Subject: [PATCH] Improve description of TestResult slightly

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>
---
 src/lib.rs | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/lib.rs b/src/lib.rs
index 2bf4bab..88c5756 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -24,7 +24,7 @@ impl<T: std::fmt::Display> From<T> for TestError {
 }
 
 #[allow(clippy::test_attr_in_doctest)] // the docs illustrate the usage in test functions
-/// Unit test result
+/// Unit test result - always panics when an error occurs
 ///
 /// This type allows panicking when encountering any type of
 /// failure. Thus it allows using the `?` operator in unit tests but still