Skip to content

Commit 0f71e92

Browse files
committed
More doc for users who use external error types
Signed-off-by: Taiki Ono <[email protected]>
1 parent 10d991b commit 0f71e92

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

lambda-runtime/src/diagnostic.rs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ use crate::{deserializer::DeserializeError, Error};
77
///
88
/// `Diagnostic` is automatically derived for some common types,
99
/// like boxed types that implement [`Error`][std::error::Error].
10+
/// If you use an error type which comes from a external crate like anyhow,
11+
/// you need convert it to common types like `Box<dyn std::error::Error>`.
12+
/// See the examples for more details.
1013
///
1114
/// [`error_type`][`Diagnostic::error_type`] is derived from the type name of
1215
/// the original error with [`std::any::type_name`] as a fallback, which may

0 commit comments

Comments
 (0)