From 6a8addd68e3cfad30b942fc2bbe3b18785b82b1a Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Sat, 3 Dec 2022 13:15:47 +0100 Subject: [PATCH] macros: more fixes to docstrings Fixes #53 and #54 --- src/macros.rs | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/macros.rs b/src/macros.rs index 80ef2c1..2c02d7c 100644 --- a/src/macros.rs +++ b/src/macros.rs @@ -1,6 +1,6 @@ /// Return early with an error. /// -/// This macro is equivalent to `return Err(From::from($err))`. +/// This macro is equivalent to `return Err(eyre!())`. /// /// # Example /// @@ -63,10 +63,10 @@ macro_rules! bail { /// Return early with an error if a condition is not satisfied. /// -/// This macro is equivalent to `if !$cond { return Err(From::from($err)); }`. +/// This macro is equivalent to `if !$cond { return Err(eyre!()); }`. /// /// Analogously to `assert!`, `ensure!` takes a condition and exits the function -/// if the condition fails. Unlike `assert!`, `ensure!` returns an `Err(Report)` +/// if the condition fails. Unlike `assert!`, `ensure!` returns an `eyre::Result` /// rather than panicking. /// /// # Example