mirror
/
rustc-dev-guide
mirror of https://github.com/rust-lang/rustc-dev-guide.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Some minor adjustments to the diagnostic documentation

This commit is contained in:
xFrednet 2021-10-28 18:30:49 +02:00 committed by Joshua Nelson
parent f3fb373be9
commit 70966e597f
1 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
src/diagnostics.md
View File

@ -26,10 +26,12 @@ LL | more code
| ^^^^ | ^^^^
``` ```
- Description (`error`, `warning`, etc.). - Level (`error`, `warning`, etc.). It indicates the severity of the message.
(See [diagnostic levels](#diagnostic-levels))
- Code (for example, for "mismatched types", it is `E0308`). It helps - Code (for example, for "mismatched types", it is `E0308`). It helps
users get more information about the current error through an extended users get more information about the current error through an extended
description of the problem in the error code index. description of the problem in the error code index. Diagnostics created
by lints don't have a code in the emitted message.
- Message. It is the main description of the problem. It should be general and - Message. It is the main description of the problem. It should be general and
able to stand on its own, so that it can make sense even in isolation. able to stand on its own, so that it can make sense even in isolation.
- Diagnostic window. This contains several things: - Diagnostic window. This contains several things:
@ -61,7 +63,11 @@ error: the fobrulator needs to be krontrificated
``` ```
When code or an identifier must appear in a message or label, it should be When code or an identifier must appear in a message or label, it should be
surrounded with backticks: `` `foo.bar` ``. surrounded with backticks:
```txt
error: the identifier `foo.bar` is invalid
```
### Error explanations ### Error explanations