Iain Stenson
c7f64046dd
## Summary This PR corrects the HTML `<src=...>` attributes in `index.md` such that they point to the right SVG files. Note: 1. There is a bar chart on the docs home page <https://docs.astral.sh/ty/>. 2. There are two SVG files and we choose which one to display depending on the theme (light or dark). 3. We currently get: 1. `ty-benchmark-cli.svg`, if we use the light theme. This has light writing, which cannot be seen against the light theme background. 2. `ty-benchmark-cli-dark.svg`, if we use the dark theme. This does not exist. 4. This PR changes these links so that we use `ty-benchmark-cli-light.svg` for the light theme and `ty-benchmark-cli.svg` for the dark theme. Both of these images already existed. ## Test Plan We manually compare the before and after appearance of the docs site. ### Light | before | after | | - | - | | <img width="775" height="300" alt="Screenshot 2026-01-12 at 10 17 27" src="https://github.com/user-attachments/assets/da3854d2-49fd-4a93-980b-2fd43c059155" /> | <img width="736" height="390" alt="Screenshot 2026-01-12 at 10 21 47" src="https://github.com/user-attachments/assets/35ae397f-163a-411d-9470-da1a727eb261" /> | ### Dark | before | after | | - | - | | <img width="775" height="300" alt="Screenshot 2026-01-12 at 10 17 19" src="https://github.com/user-attachments/assets/48f0f19a-e57b-4b64-89d0-08bad5bcef60" /> | <img width="775" height="300" alt="Screenshot 2026-01-12 at 10 21 43" src="https://github.com/user-attachments/assets/f6c2388b-acfa-4ff1-92fd-2428c9e80d84" /> | ## To the reviewer The `CONTRIBUTING.md` guidelines recommend running ```shell npx prettier --prose-wrap always --write "**/*.md" ``` after editing any markdown files. However, this changes 24 files, not only `index.md`. Should I run this as a separate commit, a separate PR or neither?
ty
An extremely fast Python type checker and language server, written in Rust.
Type checking the home-assistant project without caching.
ty is backed by Astral, the creators of uv and Ruff.
Highlights
- 10x - 100x faster than mypy and Pyright
- Comprehensive diagnostics with rich contextual information
- Configurable rule levels, per-file overrides, suppression comments, and first-class project support
- Designed for adoption, with support for redeclarations and partially typed code
- Language server with code navigation, completions, code actions, auto-import, inlay hints, on-hover help, etc.
- Fine-grained incremental analysis designed for fast updates when editing files in an IDE
- Editor integrations for VS Code, PyCharm, Neovim and more
- Advanced typing features like first-class intersection types, advanced type narrowing, and sophisticated reachability analysis
Getting started
Run ty with uvx to get started quickly:
uvx ty check
Or, check out the ty playground to try it out in your browser.
To learn more about using ty, see the documentation.
Installation
To install ty, see the installation documentation.
To add the ty language server to your editor, see the editor integration guide.
Getting help
If you have questions or want to report a bug, please open an issue in this repository.
You may also join our Discord server.
Contributing
Development of this project takes place in the Ruff repository
at this time. Please open pull requests there for changes
to anything in the ruff submodule (which includes all of the Rust source code).
See the contributing guide for more details.
FAQ
Why is ty doing _____?
See our typing FAQ.
How do you pronounce ty?
It's pronounced as "tee - why" (/tiː waɪ/)
How should I stylize ty?
Just "ty", please.
License
ty is licensed under the MIT license (LICENSE or https://opensource.org/licenses/MIT).
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in ty by you, as defined in the MIT license, shall be licensed as above, without any additional terms or conditions.
