Skip to content

Comments

Add red_knot/README.md#16230

Merged
carljm merged 7 commits intoastral-sh:mainfrom
InSyncWithFoo:rk-readme
Feb 19, 2025
Merged

Add red_knot/README.md#16230
carljm merged 7 commits intoastral-sh:mainfrom
InSyncWithFoo:rk-readme

Conversation

@InSyncWithFoo
Copy link
Contributor

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.

@AlexWaygood AlexWaygood added documentation Improvements or additions to documentation ty Multi-file analysis & type inference labels Feb 18, 2025
@InSyncWithFoo
Copy link
Contributor Author

InSyncWithFoo commented Feb 18, 2025

The "Contributing" section is rather crude. I'm not sure what to add other than a link to open issues.


Also, what does red_knot_wasm do?

Copy link
Member

@AlexWaygood AlexWaygood left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@carljm
Copy link
Contributor

carljm commented Feb 19, 2025

what does red_knot_wasm do?

It was the start of an effort to support compiling red-knot under WASM, so we could have an online red-knot playground, like the ruff playground. It's on hold because we need to remove Salsa's reliance on catch-unwind before it can be WASM compatible. My work on fixpoint iteration support in Salsa does this.

@carljm
Copy link
Contributor

carljm commented Feb 19, 2025

Looks good to me! Merging.

@carljm carljm merged commit 01c3e6b into astral-sh:main Feb 19, 2025
20 checks passed
@InSyncWithFoo InSyncWithFoo deleted the rk-readme branch February 19, 2025 08:12
dcreager added a commit that referenced this pull request Feb 19, 2025
* main:
  [red-knot] Allow any `Ranged` argument for `report_lint` and `report_diagnostic` (#16252)
  [pycodestyle] Exempt `site.addsitedir(...)` calls (E402) (#16251)
  red_knot_python_semantic: improve diagnostic message for "invalid argument type"
  ruff_db: add "secondary" messages to `Diagnostic` trait
  ruff_db: refactor snippet rendering
  red_knot_python_semantic: remove `Ranged` impl for `TypeCheckDiagnostic`
  [red-knot] Refactor `infer_chained_boolean_types` to have access to `TypeInferenceBuilder` (#16222)
  Add `red_knot/README.md` (#16230)
  [airflow] move class attributed related cases to AIR302_class_attribute (AIR302) (#16226)
  [red-knot] Update tests for attributes inferred from parameters (#16208)
  [red-knot] update TODO comment in mdtest (#16242)
  [`refurb`] Correctly handle lengths of literal strings in `slice-to-remove-prefix-or-suffix` (`FURB188`) (#16237)
  Pass `ast::PythonVersion` to `type_hint_resolves_to_any` (#16236)
  Use `ast::PythonVersion` internally in the formatter and linter (#16170)
  Add `SECURITY.md` (#16224)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation ty Multi-file analysis & type inference

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add a README file for the red_knot crate

4 participants