]> git.lizzy.rs Git - rust.git/blob - src/tools/clippy/src/docs/upper_case_acronyms.txt
Auto merge of #101615 - compiler-errors:rpitit-perf, r=oli-obk
[rust.git] / src / tools / clippy / src / docs / upper_case_acronyms.txt
1 ### What it does
2 Checks for fully capitalized names and optionally names containing a capitalized acronym.
3
4 ### Why is this bad?
5 In CamelCase, acronyms count as one word.
6 See [naming conventions](https://rust-lang.github.io/api-guidelines/naming.html#casing-conforms-to-rfc-430-c-case)
7 for more.
8
9 By default, the lint only triggers on fully-capitalized names.
10 You can use the `upper-case-acronyms-aggressive: true` config option to enable linting
11 on all camel case names
12
13 ### Known problems
14 When two acronyms are contiguous, the lint can't tell where
15 the first acronym ends and the second starts, so it suggests to lowercase all of
16 the letters in the second acronym.
17
18 ### Example
19 ```
20 struct HTTPResponse;
21 ```
22 Use instead:
23 ```
24 struct HttpResponse;
25 ```