diff options
| author | Pradyumna Rahul <prkinformed@gmail.com> | 2022-01-10 21:44:10 +0530 |
|---|---|---|
| committer | Pradyumna Rahul <prkinformed@gmail.com> | 2022-01-11 22:02:15 +0530 |
| commit | 7e989ec07a2725c8ba88f2030ef7099bb44f08e6 (patch) | |
| tree | 2ef9938af4fd6ee7d0618cee4b3f68e2965b9083 | |
| parent | b66dbe87f10c56f86270ce6eb0efd88e6e7fc1c9 (diff) | |
| download | rust-7e989ec07a2725c8ba88f2030ef7099bb44f08e6.tar.gz rust-7e989ec07a2725c8ba88f2030ef7099bb44f08e6.zip | |
Improve documentation for `borrowed-box` lint
| -rw-r--r-- | clippy_lints/src/types/mod.rs | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/clippy_lints/src/types/mod.rs b/clippy_lints/src/types/mod.rs index 481e5957435..9d57505e55e 100644 --- a/clippy_lints/src/types/mod.rs +++ b/clippy_lints/src/types/mod.rs @@ -167,8 +167,9 @@ declare_clippy_lint! { /// Check the [Box documentation](https://doc.rust-lang.org/std/boxed/index.html) for more information. /// /// ### Why is this bad? - /// Any `&Box<T>` can also be a `&T`, which is more - /// general. + /// A `&Box<T>` parameter requires the function caller to box `T` first before passing it to a function. + /// Using `&T` defines a concrete type for the parameter and generalizes the function, this would also + /// auto-deref to `&T` at the function call site if passed a `&Box<T>`. /// /// ### Example /// ```rust,ignore |