mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Auto merge of #8262 - 1nF0rmed:chore-update-borrowed-box-doc, r=camsteffen

Browse Source 
Improve documentation for `borrowed-box` lint

fixes #8161

Updates documentation to elaborate more on how removing Box from a function parameter can generalize the function.

changelog: none
This commit is contained in:
bors 2022-01-11 17:07:50 +00:00
commit 88f5be2041
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
clippy_lints/src/types/mod.rs
View File

@ -167,8 +167,9 @@
/// Check the [Box documentation](https://doc.rust-lang.org/std/boxed/index.html) for more information. /// Check the [Box documentation](https://doc.rust-lang.org/std/boxed/index.html) for more information.
/// ///
/// ### Why is this bad? /// ### Why is this bad?
/// Any `&Box<T>` can also be a `&T`, which is more /// A `&Box<T>` parameter requires the function caller to box `T` first before passing it to a function.
/// general. /// 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 /// ### Example
/// ```rust,ignore /// ```rust,ignore