about summary refs log tree commit diff
diff options
context:
space:
mode:
-rw-r--r--clippy_lints/src/await_holding_invalid.rs9
1 files changed, 3 insertions, 6 deletions
diff --git a/clippy_lints/src/await_holding_invalid.rs b/clippy_lints/src/await_holding_invalid.rs
index be905f67ec8..5659651c842 100644
--- a/clippy_lints/src/await_holding_invalid.rs
+++ b/clippy_lints/src/await_holding_invalid.rs
@@ -144,20 +144,17 @@ declare_clippy_lint! {
     ///
     /// ### Example
     ///
-    /// Strings are, of course, safe to hold across await points. This example
-    /// exists only to show how this lint might be configured for third-party
-    /// crates.
-    ///
     /// ```toml
     /// await-holding-invalid-types = [
-    ///   "std::string::String",
+    ///   "CustomLockType",
     /// ]
     /// ```
     ///
     /// ```rust
     /// # async fn baz() {}
+    /// struct CustomLockType;
     /// async fn foo() {
-    ///   let _x = String::from("hello!");
+    ///   let _x = CustomLockType;
     ///   baz().await; // Lint violation
     /// }
     /// ```