summaryrefslogtreecommitdiffstats
path: root/src/tools/clippy/src/docs/unnecessary_sort_by.txt
blob: 6913b62c48eb4b9445095309c6290ba3d125f943 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
### What it does
Detects uses of `Vec::sort_by` passing in a closure
which compares the two arguments, either directly or indirectly.

### Why is this bad?
It is more clear to use `Vec::sort_by_key` (or `Vec::sort` if
possible) than to use `Vec::sort_by` and a more complicated
closure.

### Known problems
If the suggested `Vec::sort_by_key` uses Reverse and it isn't already
imported by a use statement, then it will need to be added manually.

### Example
```
vec.sort_by(|a, b| a.foo().cmp(&b.foo()));
```
Use instead:
```
vec.sort_by_key(|a| a.foo());
```