From 0f11f656827b661f34002dc8c6840c26d3ee0521 Mon Sep 17 00:00:00 2001 From: Dave Halter Date: Mon, 16 Mar 2020 00:00:43 +0100 Subject: [PATCH] Docs: Features --- README.rst | 2 +- docs/docs/features.rst | 27 +++++++++++++-------------- 2 files changed, 14 insertions(+), 15 deletions(-) diff --git a/README.rst b/README.rst index 77525f14..33cf7bec 100644 --- a/README.rst +++ b/README.rst @@ -160,7 +160,7 @@ Refactoring Jedi supports the following refactorings: -- ``jedi.Script.inline_variable`` +- ``jedi.Script.inline`` - ``jedi.Script.rename`` - ``jedi.Script.extract_function`` - ``jedi.Script.extract_variable`` diff --git a/docs/docs/features.rst b/docs/docs/features.rst index fdbee42c..f4d1acad 100644 --- a/docs/docs/features.rst +++ b/docs/docs/features.rst @@ -9,7 +9,7 @@ Jedi's main API calls are: working in (:ref:`your REPL (IPython, etc.) `) - Goto/Type Inference: :meth:`.Script.goto` and :meth:`.Script.infer` - Static Analysis: :meth:`.Script.get_names` and :meth:`.Script.get_syntax_errors` -- Refactorings: :meth:`.Script.rename`, :meth:`.Script.inline_variable`, +- Refactorings: :meth:`.Script.rename`, :meth:`.Script.inline`, :meth:`.Script.extract_variable` and :meth:`.Script.extract_function` - Code Search: :meth:`.Script.search` and :meth:`.Project.search` @@ -57,17 +57,16 @@ Supported Python Features Not Supported ------------- -Not yet implemented: +Things that will probably never be implemented: -- manipulations of instances outside the instance variables without using - methods - -Will probably never be implemented: - -- metaclasses (how could an auto-completion ever support this) +- Arbitrary metaclasses (how could an auto-completion ever support this), some + of them like enums and dataclasses are reimplemented in Jedi to make them + work. Most of the time stubs are good enough to get type inference working, + even when metaclasses are involved. - ``setattr()``, ``__import__()`` -- writing to some dicts: ``globals()``, ``locals()``, ``object.__dict__`` - +- Writing to some dicts: ``globals()``, ``locals()``, ``object.__dict__`` +- Manipulations of instances outside the instance variables without using + methods Caveats ------- @@ -75,10 +74,10 @@ Caveats **Slow Performance** Importing ``numpy`` can be quite slow sometimes, as well as loading the -builtins the first time. If you want to speed things up, you could write import -hooks in |jedi|, which preload stuff. However, once loaded, this is not a -problem anymore. The same is true for huge modules like ``PySide``, ``wx``, -etc. +builtins the first time. If you want to speed things up, you could preload +libriaries in |jedi|, with :func:`preload_module`. However, once loaded, this +should not be a problem anymore. The same is true for huge modules like +``PySide``, ``wx``, ``tensorflow``, ``pandas``, etc. **Security**