about summary refs log tree commit diff
diff options
context:
space:
mode:
authorJonas Schievink <jonasschievink@gmail.com>2020-10-08 23:23:10 +0200
committerGitHub <noreply@github.com>2020-10-08 23:23:10 +0200
commit7edb7e7ec00df6793ea9d231b3b40f6b680a0bcd (patch)
treef76ae37c6470620fe49c867daee8050b2f015ada
parent738a41b363c27942944705fab16094704bab4e7d (diff)
parent56b51a9751600dd65ad4bbda5c0f3d7b8c6db970 (diff)
downloadrust-7edb7e7ec00df6793ea9d231b3b40f6b680a0bcd.tar.gz
rust-7edb7e7ec00df6793ea9d231b3b40f6b680a0bcd.zip
Rollup merge of #77660 - nilslice:patch-1, r=jyn514
(docs): make mutex error comment consistent with codebase

Although exceptionally minor, I found this stands out from other error reporting language used in doc comments. With the existence of the `failure` crate, I suppose this could be slightly ambiguous. In any case, this change brings the particular comment into a consistent state with other mentions of returning errors.
-rw-r--r--library/std/src/sync/mutex.rs2
1 files changed, 1 insertions, 1 deletions
diff --git a/library/std/src/sync/mutex.rs b/library/std/src/sync/mutex.rs
index e8f5a6f4294..a01ebb316e8 100644
--- a/library/std/src/sync/mutex.rs
+++ b/library/std/src/sync/mutex.rs
@@ -276,7 +276,7 @@ impl<T: ?Sized> Mutex<T> {
     /// # Errors
     ///
     /// If another user of this mutex panicked while holding the mutex, then
-    /// this call will return failure if the mutex would otherwise be
+    /// this call will return an error if the mutex would otherwise be
     /// acquired.
     ///
     /// # Examples