From c7cd84b1a49463465b7ccc04a9f2cffbde6dabe8 Mon Sep 17 00:00:00 2001 From: Dave Halter Date: Sat, 21 Mar 2020 01:25:48 +0100 Subject: [PATCH] Rework the introduction of the README/docs --- README.rst | 48 +++++++++++++++++++----------------------------- jedi/__init__.py | 22 ++++++++-------------- 2 files changed, 27 insertions(+), 43 deletions(-) diff --git a/README.rst b/README.rst index fa735fff..581b5cb1 100644 --- a/README.rst +++ b/README.rst @@ -23,18 +23,15 @@ Jedi - an awesome autocompletion, static analysis and refactoring library for Py :alt: Coverage status -Jedi is a static analysis tool for Python that can be used in IDEs/editors. -Jedi has a focus on autocompletion and goto functionality. Jedi is fast and is -very well tested. It understands Python and stubs on a deep level. +Jedi is a static analysis tool for Python that is typically used in +IDEs/editors plugins. Jedi has a focus on autocompletion and goto +functionality. Other features include refactoring, code search and finding +references. -Jedi has support for different goto functions. It's possible to search for -references and list names in a Python file to get information about them. - -Jedi uses a very simple API to connect with IDE's. There's a reference -implementation as a `VIM-Plugin `_, -which uses Jedi's autocompletion. We encourage you to use Jedi in your IDEs. -Autocompletion in your REPL is also possible, IPython uses it natively and for -the CPython REPL you have to install it. +Jedi has a simple API to work with. There is a reference implementation as a +`VIM-Plugin `_. Autocompletion in your +REPL is also possible, IPython uses it natively and for the CPython REPL you +can install it. Jedi is well tested and bugs should be rare. Jedi can currently be used with the following editors/projects: @@ -43,7 +40,7 @@ Jedi can currently be used with the following editors/projects: - Emacs (Jedi.el_, company-mode_, elpy_, anaconda-mode_, ycmd_) - Sublime Text (SublimeJEDI_ [ST2 + ST3], anaconda_ [only ST3]) - TextMate_ (Not sure if it's actually working) -- Kate_ version 4.13+ supports it natively, you have to enable it, though. [`proof +- Kate_ version 4.13+ supports it natively, you have to enable it, though. [`see `_] - Atom_ (autocomplete-python-jedi_) - `GNOME Builder`_ (with support for GObject Introspection) @@ -72,27 +69,26 @@ Get the latest version from `github `_ (master branch should always be kind of stable/working). Docs are available at `https://jedi.readthedocs.org/en/latest/ -`_. Pull requests with documentation -enhancements and/or fixes are awesome and most welcome. Jedi uses `semantic -versioning `_. +`_. Pull requests with enhancements +and/or fixes are awesome and most welcome. Jedi uses `semantic versioning +`_. If you want to stay up-to-date (News / RFCs), please subscribe to this `github thread `_.: +Issues & Questions +================== -Questions -========= - -If you have specific questions, please add an issue or ask on `Stack Overflow -`_ with the label ``python-jedi``. - +You can file issues and questions in the `issue tracker +`. Alternatively you can also ask on +`Stack Overflow `_ with +the label ``python-jedi``. Installation ============ `Check out the docs `_. - Features and Limitations ======================== @@ -128,7 +124,6 @@ There are the following commands: The returned objects are very powerful and are really all you might need. - Autocompletion in your REPL (IPython, etc.) ------------------------------------------- @@ -140,7 +135,6 @@ can look like. For the ``python`` shell you can enable tab completion in a `REPL `_. - Static Analysis --------------- @@ -175,11 +169,10 @@ Development There's a pretty good and extensive `development documentation `_. - Testing ======= -The test suite depends on ``pytest``:: +The test suite uses ``pytest``:: pip install pytest @@ -188,9 +181,6 @@ easy as:: python3.8 -m pytest -Tests are also run automatically on `Travis CI -`_. - For more detailed information visit the `testing documentation `_. diff --git a/jedi/__init__.py b/jedi/__init__.py index f361cf46..6824efe3 100644 --- a/jedi/__init__.py +++ b/jedi/__init__.py @@ -1,16 +1,13 @@ """ -Jedi is a static analysis tool for Python that can be used in IDEs/editors. -Jedi has a focus on autocompletion and goto functionality. Jedi is fast and is -very well tested. It understands Python and stubs on a deep level. +Jedi is a static analysis tool for Python that is typically used in +IDEs/editors plugins. Jedi has a focus on autocompletion and goto +functionality. Other features include refactoring, code search and finding +references. -Jedi has support for different goto functions. It's possible to search for -references and list names in a Python file to get information about them. - -Jedi uses a very simple API to connect with IDE's. There's a reference -implementation as a `VIM-Plugin `_, -which uses Jedi's autocompletion. We encourage you to use Jedi in your IDEs. -Autocompletion in your REPL is also possible, IPython uses it natively and for -the CPython REPL you have to install it. +Jedi has a simple API to work with. There is a reference implementation as a +`VIM-Plugin `_. Autocompletion in your +REPL is also possible, IPython uses it natively and for the CPython REPL you +can install it. Jedi is well tested and bugs should be rare. Here's a simple example of the autocompletion feature: @@ -28,9 +25,6 @@ Here's a simple example of the autocompletion feature: ad >>> print(completions[0].name) load - -As you see Jedi is pretty simple and allows you to concentrate on writing a -good text editor, while still having very good IDE features for Python. """ __version__ = '0.17.0'