Skip to content

Commit 7292da6

Browse files
Don't be shy about describing # correctly
1 parent 287f567 commit 7292da6

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

test-data/unit/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,10 @@ Add the test in this format anywhere in the file:
3030
with text "abc..."
3131
- note a space after `E:` and `flags:`
3232
- `# E:12` adds column number to the expected error. Example: `# E:12: ...`.
33-
- ` # ` will normally terminate the error message that comes before it;
34-
this allows for multiple comments on the same line. Example: `# E: ... # This fails`.
35-
- use `\` to escape the `#` character and indicate that the rest of the line is part of
36-
the error message. Example: `# E: This message includes the \# character once :) # new comment`.
33+
- ` # ` will terminate the error message that comes before it;
34+
this allows for multiple comments on the same line. Example: `# E: ... # This type fails`.
35+
Use `\` to escape a `#` character to include it in the error message. Example:
36+
`# E: This error message includes the \# character once # new comment`.
3737
- repeating ` # E: ` several times in one line indicates multiple expected errors in one line
3838
- `W: ...` and `N: ...` works exactly like `E: ...`, but report a warning and a note respectively
3939
- lines that don't contain the above should cause no type check errors

0 commit comments

Comments
 (0)