From d930f7e176e60479d8761cc3dddb16c262bb2811 Mon Sep 17 00:00:00 2001 From: Botahamec Date: Sun, 23 Oct 2022 16:36:21 -0400 Subject: Documentation changes --- src/exun.rs | 2 +- src/result.rs | 6 ++++++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/src/exun.rs b/src/exun.rs index d2ef1eb..7f6376e 100644 --- a/src/exun.rs +++ b/src/exun.rs @@ -8,7 +8,7 @@ use crate::{RawUnexpected, UnexpectedError}; pub use Exun::{Expected, Unexpected}; -/// `Expect` is a type that represents either the expected error type +/// `Exun` is a type that represents either the expected error type /// ([`Expected`]) or an unexpected type ([`Unexpected`]). /// /// See the [crate documentation](crate) for details. diff --git a/src/result.rs b/src/result.rs index 2b8921c..dfcb7ef 100644 --- a/src/result.rs +++ b/src/result.rs @@ -10,6 +10,9 @@ mod sealed { use sealed::Sealed; +/// Provides [`Result::unexpect`] +/// +/// [`Result::unexpect`]: `ResultErrorExt::unexpect` #[cfg(feature = "std")] pub trait ResultErrorExt: Sealed { /// Converts `Result` to `Result`. @@ -62,6 +65,9 @@ impl ResultErrorExt for Result { } } +/// Provides [`Result::unexpect_msg`] +/// +/// [`Result::unexpect_msg`]: `ResultMsgExt::unexpect_msg` pub trait ResultMsgExt: Sealed { /// Converts `Result` to `Result`. /// -- cgit v1.2.3