From d7db61502adf14a6ac6babd04580377e09fe3eaf Mon Sep 17 00:00:00 2001 From: Botahamec Date: Mon, 6 Jan 2025 22:08:01 -0500 Subject: Fix documentation --- src/lockable.rs | 4 ++-- src/poisonable.rs | 1 + 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/src/lockable.rs b/src/lockable.rs index 7ddc104..70d442a 100644 --- a/src/lockable.rs +++ b/src/lockable.rs @@ -151,7 +151,7 @@ pub unsafe trait Sharable: Lockable { /// # Safety /// /// All locks given by calling [`Lockable::get_ptrs`] must be locked using - /// [`RawLock::read`] before calling this function. The locks must not be + /// [`RawLock::raw_read`] before calling this function. The locks must not be /// unlocked until this guard is dropped. #[must_use] unsafe fn read_guard(&self) -> Self::ReadGuard<'_>; @@ -188,7 +188,7 @@ pub trait LockableIntoInner: Lockable { /// [`Lockable`]. /// /// This is used for types like [`Poisonable`] to access the inner value of a -/// lock. [`Poisonable::get_mut`] calls [`LockableAsMut::as_mut`] to return a +/// lock. [`Poisonable::get_mut`] calls [`LockableGetMut::get_mut`] to return a /// mutable reference of the inner value. This isn't implemented for some /// `Lockable`s, such as `&[T]`. /// diff --git a/src/poisonable.rs b/src/poisonable.rs index f9152d1..da7758f 100644 --- a/src/poisonable.rs +++ b/src/poisonable.rs @@ -28,6 +28,7 @@ pub(crate) struct PoisonFlag(#[cfg(panic = "unwind")] AtomicBool); /// indicate that all invariants of the underlying data are upheld, so that /// subsequent calls may still return [`Ok`]. /// +/// [`Lockable`]: `crate::lockable::Lockable` /// [`lock`]: `Poisonable::lock` /// [`try_lock`]: `Poisonable::try_lock` /// [`into_inner`]: `PoisonError::into_inner` -- cgit v1.2.3