From 5bc6ce231bcc00150f25f3ebe081d2be1d7818e3 Mon Sep 17 00:00:00 2001 From: Dave Halter Date: Sat, 14 Dec 2019 11:27:52 +0100 Subject: [PATCH] Add a typeshed README --- jedi/third_party/README_typeshed.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 jedi/third_party/README_typeshed.md diff --git a/jedi/third_party/README_typeshed.md b/jedi/third_party/README_typeshed.md new file mode 100644 index 00000000..516b030e --- /dev/null +++ b/jedi/third_party/README_typeshed.md @@ -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