Add a typeshed README

This commit is contained in:
Dave Halter
2019-12-14 11:27:52 +01:00
parent a6bf49783f
commit 5bc6ce231b

14
jedi/third_party/README_typeshed.md vendored Normal file
View File

@@ -0,0 +1,14 @@
# Typeshed in Jedi
Typeshed is used in Jedi to provide completions for all the stdlib modules.
The relevant files in jedi are in `jedi/inference/gradual`. `gradual` stands
for "gradual typing".
## Updating Typeshed
Currently Jedi has a custom implementation hosted in
https://github.com/davidhalter/typeshed.git for two reasons:
- Jedi doesn't understand Tuple.__init__ properly.
- Typeshed has a bug: https://github.com/python/typeshed/issues/2999