Skip to content

Commit 2fc4668

Browse files
committed
Tweak Error trait docs to reflect actual requirements
1 parent 03f46ad commit 2fc4668

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

src/libstd/error.rs

+3-3
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,9 @@ use str;
3636
use string;
3737

3838
/// `Error` is a trait representing the basic expectations for error values,
39-
/// i.e. values of type `E` in [`Result<T, E>`]. At a minimum, errors must provide
40-
/// a description, but they may optionally provide additional detail (via
41-
/// [`Display`]) and cause chain information:
39+
/// i.e. values of type `E` in [`Result<T, E>`]. Errors must describe
40+
/// themselves through the [`Display`] and [`Debug`] traits, and may provide
41+
/// cause chain information:
4242
///
4343
/// The [`cause`] method is generally used when errors cross "abstraction
4444
/// boundaries", i.e. when a one module must report an error that is "caused"

0 commit comments

Comments
 (0)