Document that wildcard_imports doesn't warn about use ...::prelude::*;

2020-03-13 17:07:11 +00:00 · 2020-03-13 17:07:11 +00:00 · f56b0a1b34
commit f56b0a1b34
parent 2d8a362cbe
1 changed files with 4 additions and 0 deletions
--- a/clippy_lints/src/wildcard_imports.rs
+++ b/clippy_lints/src/wildcard_imports.rs
@ -43,6 +43,10 @@
    ///
    /// 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.
    ///