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

Fix typo, clarify backtick wording, and use inline code

This commit is contained in:
Noah Lev 2021-08-28 15:07:20 -07:00 committed by Joshua Nelson
parent 2f447292ff
commit fa6a787cfd
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/diagnostics.md
View File

@ -38,7 +38,7 @@ LL | more code
- Primary and secondary spans underlying the users' code. These spans can - Primary and secondary spans underlying the users' code. These spans can
optionally contain one or more labels. optionally contain one or more labels.
- Primary spans should have enough text to describe the problem in such a - Primary spans should have enough text to describe the problem in such a
way that if it where the only thing being displayed (for example, in an way that if it were the only thing being displayed (for example, in an
IDE) it would still make sense. Because it is "spatially aware" (it IDE) it would still make sense. Because it is "spatially aware" (it
points at the code), it can generally be more succinct than the error points at the code), it can generally be more succinct than the error
message. message.
@ -61,7 +61,7 @@ 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 single acute accents \`. surrounded with backticks: `` `foo.bar` ``.
### Error explanations ### Error explanations
@ -449,8 +449,8 @@ The possible values of [`Applicability`][appl] are:
- `MachineApplicable`: Can be applied mechanically. - `MachineApplicable`: Can be applied mechanically.
- `HasPlaceholders`: Cannot be applied mechanically because it has placeholder - `HasPlaceholders`: Cannot be applied mechanically because it has placeholder
text in the suggestions. For example, "Try adding a type: \`let x: text in the suggestions. For example: ``try adding a type: `let x:
\<type\>\`". <type>` ``.
- `MaybeIncorrect`: Cannot be applied mechanically because the suggestion may - `MaybeIncorrect`: Cannot be applied mechanically because the suggestion may
or may not be a good one. or may not be a good one.
- `Unspecified`: Cannot be applied mechanically because we don't know which - `Unspecified`: Cannot be applied mechanically because we don't know which