bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

Make the lint docstrings more consistent.

Browse source
This commit is contained in:
Georg Brandl 2016-08-06 09:55:04 +02:00
parent bc2ecc9623
commit 3b5ff0f813
72 changed files with 914 additions and 677 deletions
Download patch file Download diff file Expand all files Collapse all files

12
clippy_lints/src/mut_reference.rs
View file

@ -4,15 +4,15 @@ use rustc::hir::*;
use syntax::ptr::P;
use utils::span_lint;
/// **What it does:** This lint detects giving a mutable reference to a function that only requires
/// an immutable reference.
/// **What it does:** Detects giving a mutable reference to a function that only
/// requires an immutable reference.
///
/// **Why is this bad?** The immutable reference rules out all other references to the value. Also
/// the code misleads about the intent of the call site.
/// **Why is this bad?** The immutable reference rules out all other references
/// to the value. Also the code misleads about the intent of the call site.
///
/// **Known problems:** None
/// **Known problems:** None.
///
/// **Example**
/// **Example:**
/// ```rust
/// my_vec.push(&mut value)
/// ```