Skip to content

Commit fdb5626

Browse files
Mention test file comments
1 parent 27da6c2 commit fdb5626

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

test-data/unit/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,10 @@ with text "abc..."
4242
- repeating ` # E: ` several times in one line indicates multiple expected errors in one line
4343
- `W: ...` and `N: ...` work exactly like `E: ...`, but report a warning and a note respectively
4444
- lines that don't contain the above should cause no type check errors
45+
- lines that begin with `--` are test-file-format comments, and will not appear in the tested python
46+
source code
47+
- some test files are run in a special way by the test runner; this is typically documented in
48+
test-file-format comments at the top of the test file
4549
- optional `[builtins fixtures/...]` tells the type checker to use
4650
`builtins` stubs from the indicated file (see Fixtures section below)
4751
- optional `[out]` is an alternative to the `# E: ` notation: it indicates that

0 commit comments

Comments
 (0)