Add warning for NEEDLESS_PASS_BY_REF_MUT lint about the fact that i…

…t changes API
rust-lang · Jul 3, 2023 · 33adfcd · 33adfcd
1 parent dd3e00f
commit 33adfcd
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/clippy_lints/src/needless_pass_by_ref_mut.rs b/clippy_lints/src/needless_pass_by_ref_mut.rs
@@ -22,6 +22,9 @@ declare_clippy_lint! {
     /// ### What it does
     /// Check if a `&mut` function argument is actually used mutably.
     ///
+    /// Be careful if the function is publically reexported as it would break compatibility with
+    /// users of this function.
+    ///
     /// ### Why is this bad?
     /// Less `mut` means less fights with the borrow checker. It can also lead to more
     /// opportunities for parallelization.