Documentation

1 files changed, 3 insertions, 1 deletions

diff --git a/src/rwlock/read_guard.rs b/src/rwlock/read_guard.rs
index da3d101..e46078c 100644
--- a/src/rwlock/read_guard.rs
+++ b/src/rwlock/read_guard.rs
@@ -46,7 +46,9 @@ impl<'a, T: ?Sized + 'a, R: RawRwLock> Drop for RwLockReadRef<'a, T, R> {
 }
 
 impl<'a, T: ?Sized + 'a, R: RawRwLock> RwLockReadRef<'a, T, R> {
-	pub unsafe fn new(mutex: &'a RwLock<T, R>) -> Self {
+	/// Creates an immutable reference for the underlying data of an [`RwLock`]
+	/// without locking it or taking ownership of the key.
+	pub(crate) unsafe fn new(mutex: &'a RwLock<T, R>) -> Self {
 		Self(mutex, PhantomData)
 	}
 }