From f122c9b5b30db96eb620b9793426cce490330f8a Mon Sep 17 00:00:00 2001 From: Dave Halter Date: Wed, 8 Apr 2015 13:15:21 +0200 Subject: [PATCH] Document the new features better in the next release. --- README.rst | 8 ++++---- docs/docs/features.rst | 14 ++++++++++++++ 2 files changed, 18 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index db9aef51..85691b01 100644 --- a/README.rst +++ b/README.rst @@ -53,7 +53,7 @@ And it powers the following projects: - wdb_ - Web Debugger -Here are some pictures: +Here are some pictures taken from jedi-vim_: .. image:: https://github.com/davidhalter/jedi/raw/master/docs/_screenshots/screenshot_complete.png @@ -65,7 +65,7 @@ Display of function/class bodies, docstrings. .. image:: https://github.com/davidhalter/jedi/raw/master/docs/_screenshots/screenshot_pydoc.png -Pydoc support (with highlighting, Shift+k). +Pydoc support (Shift+k). There is also support for goto and renaming. @@ -131,8 +131,8 @@ This means that IPython and others are `supported `_. -Static Analysis ---------------- +Static Analysis / Linter +------------------------ To do all forms of static analysis, please try to use ``jedi.names``. It will return a list of names that you can use to infer types and so on. diff --git a/docs/docs/features.rst b/docs/docs/features.rst index 4867bee3..48c41ead 100644 --- a/docs/docs/features.rst +++ b/docs/docs/features.rst @@ -3,6 +3,20 @@ Features and Caveats ==================== +Jedi obviously supports autocompletion. It's also possible to get it working in +(:ref:`your REPL (IPython, etc.) `). + +Static analysis is also possible by using the command ``jedi.names``. + +The Jedi Linter is currently in an alpha version and can be tested by calling +``python -m jedi linter``. + +Jedi would in theory support refactoring, but we have never publicized it, +because it's not production ready. If you're interested in helping out here, +let me know. With the latest parser changes, it should be very easy to actually +make it work. + + General Features ----------------