From 9a10d32c9a2c2c7ff26a56c399d3b1f39138d40d Mon Sep 17 00:00:00 2001 From: y21 <30553356+y21@users.noreply.github.com> Date: Sat, 28 Oct 2023 02:29:33 +0200 Subject: [PATCH] reword limitation section --- clippy_lints/src/iter_without_into_iter.rs | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/clippy_lints/src/iter_without_into_iter.rs b/clippy_lints/src/iter_without_into_iter.rs index e3cb29da5e12..eb5f1747d83d 100644 --- a/clippy_lints/src/iter_without_into_iter.rs +++ b/clippy_lints/src/iter_without_into_iter.rs @@ -20,9 +20,9 @@ declare_clippy_lint! { /// (`for val in &iter {}`), without having to first call `iter()` or `iter_mut()`. /// /// ### Limitations - /// This lint is restricted to exported types only, because it is aimed at guiding towards an - /// idiomatic, _public_ API. - /// Implementing the `IntoIterator` trait when it is not needed or used anywhere doesn't help or improve the code. + /// This lint focuses on providing an idiomatic API. Therefore, it will only + /// lint on types which are accessible outside of the crate. For internal types, + /// the `IntoIterator` trait can be implemented on demand if it is actually needed. /// /// ### Example /// ```rust @@ -67,10 +67,12 @@ declare_clippy_lint! { /// in case of ambiguity with another `IntoIterator` impl. /// /// ### Limitations - /// This lint is restricted to exported types only, because it is aimed at guiding towards an - /// idiomatic, _public_ API. - /// Adding an `iter` or `iter_mut` for private types when it is not needed or used doesn't improve code, - /// and in fact, is linted against by the `dead_code` lint. + /// This lint focuses on providing an idiomatic API. Therefore, it will only + /// lint on types which are accessible outside of the crate. For internal types, + /// these methods can be added on demand if they are actually needed. Otherwise, + /// it would trigger the [`dead_code`] lint for the unused method. + /// + /// [`dead_code`]: https://doc.rust-lang.org/rustc/lints/listing/warn-by-default.html#dead-code /// /// ### Example /// ```rust