summaryrefslogtreecommitdiffstats
path: root/src/tools/clippy/src/docs/used_underscore_binding.txt
blob: ed67c41eb0dbf2f935273adb96ddd14579c604dc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
### What it does
Checks for the use of bindings with a single leading
underscore.

### Why is this bad?
A single leading underscore is usually used to indicate
that a binding will not be used. Using such a binding breaks this
expectation.

### Known problems
The lint does not work properly with desugaring and
macro, it has been allowed in the mean time.

### Example
```
let _x = 0;
let y = _x + 1; // Here we are using `_x`, even though it has a leading
                // underscore. We should rename `_x` to `x`
```