From c205d2e71bd216fc9b189519ce5d4ce0c92cddc9 Mon Sep 17 00:00:00 2001 From: Paul Colomiets Date: Sat, 8 Jan 2022 03:35:48 +0200 Subject: [PATCH] docs: fix mentions of eyre and DiagnosticError (#100) Note: `DiagnosticError` is a private type, `Report` returned from `into_diagnostic()` instead. --- src/eyreish/into_diagnostic.rs | 2 +- src/eyreish/mod.rs | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/src/eyreish/into_diagnostic.rs b/src/eyreish/into_diagnostic.rs index 3e03694..be24f1a 100644 --- a/src/eyreish/into_diagnostic.rs +++ b/src/eyreish/into_diagnostic.rs @@ -10,7 +10,7 @@ struct DiagnosticError(Box); impl Diagnostic for DiagnosticError {} /** -Convenience trait that adds a `.into_diagnostic()` method that converts a type to a `Result`. +Convenience trait that adds a `.into_diagnostic()` method that converts a type to a `Result`. */ pub trait IntoDiagnostic { /// Converts [Result]-like types that return regular errors into a diff --git a/src/eyreish/mod.rs b/src/eyreish/mod.rs index 6082356..05d9a99 100644 --- a/src/eyreish/mod.rs +++ b/src/eyreish/mod.rs @@ -322,7 +322,7 @@ pub type Result = core::result::Result; /// After attaching a message of type `D` onto an error of type `E`, the resulting /// `miette::Error` may be downcast to `D` **or** to `E`. /// -/// That is, in codebases that rely on downcasting, Eyre's wrap_err supports +/// That is, in codebases that rely on downcasting, miette's wrap_err supports /// both of the following use cases: /// /// - **Attaching messages whose type is insignificant onto errors whose type @@ -330,7 +330,7 @@ pub type Result = core::result::Result; /// /// In other error libraries whose wrap_err is not designed this way, it can /// be risky to introduce messages to existing code because new message might -/// break existing working downcasts. In Eyre, any downcast that worked +/// break existing working downcasts. In miette, any downcast that worked /// before adding the message will continue to work after you add a message, so /// you should freely wrap errors wherever it would be helpful. ///