diff --git a/docs/README.md b/docs/README.md index fef7c1866..8ab85af8e 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,8 +2,8 @@ # Static type checker for Python -Pyright is a full-featured, standards-based static type checker for Python. It is designed for high performance and can be used with large Python source bases. +Pyright is a full-featured, [standards-compliant](https://htmlpreview.github.io/?https://github.com/python/typing/blob/main/conformance/results/results.html) static type checker for Python. It is designed for high performance and can be used with large Python source bases. -Pyright includes both a [command-line tool](command-line.md) and an [extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=ms-pyright.pyright). +Pyright includes a [command-line tool](command-line.md), a language server, and an [extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=ms-pyright.pyright). diff --git a/docs/type-concepts.md b/docs/type-concepts.md index aabbd50a1..884751c89 100644 --- a/docs/type-concepts.md +++ b/docs/type-concepts.md @@ -1,6 +1,7 @@ ## Static Typing: The Basics -Getting started with static type checking in Python is easy, but it’s important to understand a few simple concepts. +Getting started with static type checking in Python is easy, but it’s important to understand a few simple concepts. In addition to the documentation below, you may also find the community-maintained [Static Typing Documentation](https://typing.readthedocs.io/en/latest/) to be of use. That site also includes the official [Specification for the Python Type System](https://typing.readthedocs.io/en/latest/spec/index.html). + ### Type Declarations When you add a type annotation to a variable or a parameter in Python, you are _declaring_ that the symbol will be assigned values that are compatible with that type. You can think of type annotations as a powerful way to comment your code. Unlike text-based comments, these comments are readable by both humans and enforceable by type checkers.