add note for err annotation formatting

This commit is contained in:
Rageking8 2022-10-28 00:29:19 +08:00 committed by Tshepang Mbambo
parent bd8eeff467
commit 88bd6ca6ab
1 changed files with 4 additions and 0 deletions

View File

@ -207,6 +207,10 @@ There are several ways to match the message with the line (see the examples belo
This is more convenient than using multiple carets when there are multiple This is more convenient than using multiple carets when there are multiple
messages associated with the same line. messages associated with the same line.
The space character between `//~` (or other variants) and the subsequent text
is negligible (i.e. there is no semantic difference between `//~ ERROR` and
`//~ERROR` although the former is more common in the codebase).
### Error annotation examples ### Error annotation examples
Here are examples of error annotations on different lines of UI test Here are examples of error annotations on different lines of UI test