From 01c3e6b94f937bb12850a2f2f0fbd9b86727f455 Mon Sep 17 00:00:00 2001 From: InSync Date: Wed, 19 Feb 2025 14:31:02 +0700 Subject: [PATCH] Add `red_knot/README.md` (#16230) ## Summary Resolves #15979. The file explains what Red Knot is (a type checker), what state it is in (not yet ready for user testing), what its goals ("extremely fast") and non-goals (not a drop-in replacement for other type checkers) are as well as what the crates contain. ## Test Plan None. --------- Co-authored-by: Alex Waygood --- crates/red_knot/README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 crates/red_knot/README.md diff --git a/crates/red_knot/README.md b/crates/red_knot/README.md new file mode 100644 index 0000000000..de53ab22c9 --- /dev/null +++ b/crates/red_knot/README.md @@ -0,0 +1,25 @@ +# Red Knot + +Red Knot is an extremely fast type checker. +Currently, it is a work-in-progress and not ready for user testing. + +Red Knot is designed to prioritize good type inference, even in unannotated code, +and aims to avoid false positives. + +While Red Knot will produce similar results to mypy and pyright on many codebases, +100% compatibility with these tools is a non-goal. +On some codebases, Red Knot's design decisions lead to different outcomes +than you would get from running one of these more established tools. + +## Contributing + +Core type checking tests are written as Markdown code blocks. +They can be found in [`red_knot_python_semantic/resources/mdtest`][resources-mdtest]. +See [`red_knot_test/README.md`][mdtest-readme] for more information +on the test framework itself. + +The list of open issues can be found [here][open-issues]. + +[mdtest-readme]: ../red_knot_test/README.md +[open-issues]: https://github.com/astral-sh/ruff/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20label%3Ared-knot +[resources-mdtest]: ../red_knot_python_semantic/resources/mdtest