Added Limitations and FAQ section.

This commit is contained in:
Eric Traut 2019-03-19 16:07:43 -07:00
parent 5c9f643ea1
commit a6f67641ed

View File

@ -21,7 +21,6 @@ Pyright supports:
* Type inference for function return values, instance variables, class variables, and globals
* Smart conditional type exclusions
### Built-in Type Stubs
Pyright includes a recent copy of the stdlib type stubs from [Typeshed](https://github.com/python/typeshed). It can be configured to use another (perhaps more recent or modified) copy of the Typeshed type stubs. Of course, it also works with custom type stub files that are part of your project.
@ -35,6 +34,18 @@ Pyright offers the following language service features:
* Links to symbol definitions
## Limitations
Pyright currently provides support for Python 3.0 and newer. There is currently no plan to support older versions.
## FAQ
Q: What is the difference between pyright and the [Microsoft Python VS Code plugin](https://github.com/Microsoft/vscode-python)?
A: The Python VS Code plugin is the official Python support extension for VS Code. It is officially supported by a team of engineers at Microsoft. It supports a diverse array of features including debugging, linter plugins, type checking plugins, and much more. Pyright is focused entirely on type checking. It is a side project with no dedicated team.
Q: What is the difference between pyright and the [Microsoft Python Language Server](https://github.com/Microsoft/python-language-server)?
A: The Microsoft Python Language Server is a [language server protocol (LSP)](https://microsoft.github.io/language-server-protocol/) implementation that works with the Microsoft Python VS Code plugin. It also provides type checking capabilities. Pyright's provides overlapping functionality but provides some unique features such as more configurabilty, command-line execution, and better performance.
## Build Instructions
To build the project:
1. Install [nodejs](https://nodejs.org/en/)