Documentation

1 files changed, 6 insertions, 1 deletions

diff --git a/src/mutex/mutex.rs b/src/mutex/mutex.rs
index 505ff83..9b71ea4 100644
--- a/src/mutex/mutex.rs
+++ b/src/mutex/mutex.rs
@@ -247,9 +247,14 @@ impl<T: ?Sized, R: RawMutex> Mutex<T, R> {
 
 	/// Attempts to lock the `Mutex` without blocking.
 	///
+	/// If the access could not be granted at this time, then `Err` is
+	/// returned. Otherwise, an RAII guard is returned which will release the
+	/// lock when it is dropped.
+	///
 	/// # Errors
 	///
-	/// Returns [`Err`] if the `Mutex` cannot be locked without blocking.
+	/// If the mutex could not be acquired because it is already locked, then
+	/// this call will return an error containing the given key.
 	///
 	/// # Examples
 	///