Skip to content

Commit

Permalink
Fix typo, clarify backtick wording, and use inline code
Browse files Browse the repository at this point in the history
  • Loading branch information
camelid authored and jyn514 committed Aug 31, 2021
1 parent 2f44729 commit fa6a787
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions src/diagnostics.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ LL | more code
- Primary and secondary spans underlying the users' code. These spans can
optionally contain one or more labels.
- 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
points at the code), it can generally be more succinct than the error
message.
Expand All @@ -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
surrounded with single acute accents \`.
surrounded with backticks: `` `foo.bar` ``.

### Error explanations

Expand Down Expand Up @@ -449,8 +449,8 @@ The possible values of [`Applicability`][appl] are:

- `MachineApplicable`: Can be applied mechanically.
- `HasPlaceholders`: Cannot be applied mechanically because it has placeholder
text in the suggestions. For example, "Try adding a type: \`let x:
\<type\>\`".
text in the suggestions. For example: ``try adding a type: `let x:
<type>` ``.
- `MaybeIncorrect`: Cannot be applied mechanically because the suggestion may
or may not be a good one.
- `Unspecified`: Cannot be applied mechanically because we don't know which
Expand Down

0 comments on commit fa6a787

Please sign in to comment.