Skip to content

Commit c73fa7d

Browse files
authored
Add links to conformance tests & results (#2246)
1 parent e59dccd commit c73fa7d

File tree

2 files changed

+5
-1
lines changed

2 files changed

+5
-1
lines changed

conformance/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ Note that some type checkers may not run on some platforms. If a type checker fa
8181

8282
Different type checkers report errors in different ways (with different wording in error messages and different line numbers or character ranges for errors). This variation makes it difficult to fully automate test validation given that tests will want to check for both false positive and false negative type errors. Some level of manual inspection will therefore be needed to determine whether a type checker is fully conformant with all tests in any given test file. This "scoring" process is required only when the output of a test changes — e.g. when a new version of that type checker is released and the tests are rerun. We assume that the output of a type checker will be the same from one run to the next unless/until a new version is released that fixes or introduces a bug. In this case, the output will need to be manually inspected and the conformance results re-scored for those tests whose output has changed.
8383

84-
Conformance results are reported and summarized for each supported type checker. Currently, results are reported for mypy, pyrefly, pyright, zuban and ty. It is the goal and desire to add additional type checkers over time.
84+
[Conformance results](https://htmlpreview.github.io/?https://github.com/python/typing/blob/main/conformance/results/results.html) are reported and summarized for each supported type checker. Currently, results are reported for mypy, pyrefly, pyright, zuban and ty. It is the goal and desire to add additional type checkers over time.
8585

8686
## Adding a New Test Case
8787

docs/index.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,10 @@ Type Checkers
8585
* `ty <https://docs.astral.sh/ty/>`_
8686
* `Zuban <https://docs.zubanls.com/en/latest/>`_
8787

88+
The extent to which these adhere to the specification is monitored by a
89+
`conformance test suite <https://github.com/python/typing/tree/main/conformance>`_
90+
(`results <https://htmlpreview.github.io/?https://github.com/python/typing/blob/main/conformance/results/results.html>`_).
91+
8892
Development Environments
8993
------------------------
9094

0 commit comments

Comments
 (0)