about summary refs log tree commit diff
diff options
context:
space:
mode:
authorbors <bors@rust-lang.org>2020-03-14 12:17:09 +0000
committerbors <bors@rust-lang.org>2020-03-14 12:17:09 +0000
commitdf64ea682c9257274cf57ec7debcd46593c22e9c (patch)
tree6c1ed09f29868650faf6e014c9cf4107575731fa
parentceb9b7d66de723a2d312d72a796d23142bbc6329 (diff)
parentf56b0a1b347342d6244bb533f820ed0f93244c4e (diff)
downloadrust-df64ea682c9257274cf57ec7debcd46593c22e9c.tar.gz
rust-df64ea682c9257274cf57ec7debcd46593c22e9c.zip
Auto merge of #5312 - joshtriplett:wildcard-prelude-documentation, r=flip1995
Document that wildcard_imports doesn't warn about `use ...::prelude::*;`

changelog: Improve [`wildcard_imports`] documentation
-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.
     ///