Improve regression test documentation (#10935)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
This commit is contained in:
Sebastian Rittau
2023-10-29 11:07:17 +01:00
committed by GitHub
parent c74c8b0507
commit f7aa7b709a
3 changed files with 13 additions and 2 deletions

View File

@@ -32,6 +32,13 @@ stubs where decisions have been taken that might be slightly unusual. These
test cases serve a different purpose: to check that type checkers do not emit
false-positive errors for idiomatic usage of these classes.
## Running the tests
To verify the test cases in this directory pass with mypy, run `python tests/regr_test.py stdlib`
from the root of the typeshed repository. This assumes that the development
environment has been set up as described in the [CONTRIBUTING.md](../CONTRIBUTING.md)
document.
### How the tests work
The code in this directory is not intended to be directly executed. Instead,