mirror of
https://github.com/davidhalter/jedi.git
synced 2026-05-17 22:09:37 +08:00
Document the new features better in the next release.
This commit is contained in:
+4
-4
@@ -53,7 +53,7 @@ And it powers the following projects:
|
|||||||
- wdb_ - Web Debugger
|
- 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
|
.. 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
|
.. 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.
|
There is also support for goto and renaming.
|
||||||
|
|
||||||
@@ -131,8 +131,8 @@ This means that IPython and others are `supported
|
|||||||
<https://jedi.readthedocs.org/en/latest/docs/usage.html#tab-completion-in-the-python-shell>`_.
|
<https://jedi.readthedocs.org/en/latest/docs/usage.html#tab-completion-in-the-python-shell>`_.
|
||||||
|
|
||||||
|
|
||||||
Static Analysis
|
Static Analysis / Linter
|
||||||
---------------
|
------------------------
|
||||||
|
|
||||||
To do all forms of static analysis, please try to use ``jedi.names``. It will
|
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.
|
return a list of names that you can use to infer types and so on.
|
||||||
|
|||||||
@@ -3,6 +3,20 @@
|
|||||||
Features and Caveats
|
Features and Caveats
|
||||||
====================
|
====================
|
||||||
|
|
||||||
|
Jedi obviously supports autocompletion. It's also possible to get it working in
|
||||||
|
(:ref:`your REPL (IPython, etc.) <repl-completion>`).
|
||||||
|
|
||||||
|
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
|
General Features
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user