Skip to content

Commit

Permalink
docs: correct "eyre::Error" to "eyre::Report" (#69)
Browse files Browse the repository at this point in the history
  • Loading branch information
jeremyBanks authored Jan 31, 2022
1 parent fb77d1b commit 2c9a940
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -820,7 +820,7 @@ pub struct Chain<'a> {
///
/// # const IGNORE: &str = stringify! {
/// fn demo1() -> Result<T> {...}
/// // ^ equivalent to std::result::Result<T, eyre::Error>
/// // ^ equivalent to std::result::Result<T, eyre::Report>
///
/// fn demo2() -> Result<T, OtherError> {...}
/// // ^ equivalent to std::result::Result<T, OtherError>
Expand Down Expand Up @@ -936,7 +936,7 @@ pub type Result<T, E = Report> = core::result::Result<T, E>;
/// # Effect on downcasting
///
/// After attaching a message of type `D` onto an error of type `E`, the resulting
/// `eyre::Error` may be downcast to `D` **or** to `E`.
/// `eyre::Report` may be downcast to `D` **or** to `E`.
///
/// That is, in codebases that rely on downcasting, Eyre's wrap_err supports
/// both of the following use cases:
Expand Down

0 comments on commit 2c9a940

Please sign in to comment.