about summary refs log tree commit diff
diff options
context:
space:
mode:
authorJosh Triplett <josh@joshtriplett.org>2020-03-13 17:07:11 +0000
committerJosh Triplett <josh@joshtriplett.org>2020-03-13 17:07:11 +0000
commitf56b0a1b347342d6244bb533f820ed0f93244c4e (patch)
treea82e4bf71a77a46442008c993edc9f126fb56d91
parent2d8a362cbebf67c755c01616f17687a7fc54cd24 (diff)
downloadrust-f56b0a1b347342d6244bb533f820ed0f93244c4e.tar.gz
rust-f56b0a1b347342d6244bb533f820ed0f93244c4e.zip
Document that wildcard_imports doesn't warn about `use ...::prelude::*;`
-rw-r--r--clippy_lints/src/wildcard_imports.rs4
1 files changed, 4 insertions, 0 deletions
diff --git a/clippy_lints/src/wildcard_imports.rs b/clippy_lints/src/wildcard_imports.rs
index 17e067a095d..6f8cec7c056 100644
--- a/clippy_lints/src/wildcard_imports.rs
+++ b/clippy_lints/src/wildcard_imports.rs
@@ -43,6 +43,10 @@ declare_clippy_lint! {
     ///
     /// This can lead to confusing error messages at best and to unexpected behavior at worst.
     ///
+    /// Note that this will not warn about wildcard imports from modules named `prelude`; many
+    /// crates (including the standard library) provide modules named "prelude" specifically
+    /// designed for wildcard import.
+    ///
     /// **Known problems:** If macros are imported through the wildcard, this macro is not included
     /// by the suggestion and has to be added by hand.
     ///