Skip to content

Commit a905cf6

Browse files
committed
Added documentation for common abbreviations
This list was created as a collaborative effort on Zulip and the [thread] is definitely worth a read as we had quite some fun. A big **THANK YOU** goes out to everyone who participated you make this project fun to work on!!! The Zulip [thread]: https://rust-lang.zulipchat.com/#narrow/stream/257328-clippy/topic/Common.20abbreviations.20in.20basics.2Emd/near/223548065
1 parent 043cf97 commit a905cf6

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

doc/basics.md

+19
Original file line numberDiff line numberDiff line change
@@ -94,3 +94,22 @@ cargo dev ra_setup
9494

9595
We follow a rustc no merge-commit policy.
9696
See <https://rustc-dev-guide.rust-lang.org/contributing.html#opening-a-pr>.
97+
98+
## Common Abbreviations
99+
100+
| Abbreviation | Meaning |
101+
| ------------ | -------------------------------------- |
102+
| UB | Undefined Behavior |
103+
| FP | False Positive |
104+
| FN | False Negative |
105+
| ICE | Internal Compiler Error |
106+
| AST | Abstract Syntax Tree |
107+
| MIR | Mid-Level Intermediate Representation |
108+
| HIR | High-Level Intermediate Representation |
109+
| TCX | Type context |
110+
111+
This is a concise list of abbreviations that can come up during clippy development. An extensive
112+
genal list can be found in the [rustc-dev-guide glossary][glossary]. Always feel free to ask if
113+
an abbreviation or meaning is unclear to you.
114+
115+
[glossary]: https://rustc-dev-guide.rust-lang.org/appendix/glossary.html

0 commit comments

Comments
 (0)