itsscb/eyre
1
0
Fork 0
mirror of https://github.com/eyre-rs/eyre.git synced 2025-09-27 04:50:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: correct "eyre::Error" to "eyre::Report" (#69)

Browse Source
This commit is contained in:
Jeremy Banks 2022-01-31 13:25:08 -05:00 committed by GitHub
parent fb77d1b783
commit 2c9a940e1d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/lib.rs
View File

@ -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>
@ -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: