diff --git a/docs/docs/development.rst b/docs/docs/development.rst index 3025a262..1b9e1f5f 100644 --- a/docs/docs/development.rst +++ b/docs/docs/development.rst @@ -8,6 +8,8 @@ Jedi Development .. note:: This documentation is for Jedi developers who want to improve Jedi itself, but have no idea how Jedi works. If you want to use Jedi for your IDE, look at the `plugin api `_. + It is also important to note that it's a pretty old version and some things + might not apply anymore. Introduction diff --git a/docs/docs/installation.rst b/docs/docs/installation.rst index 1070a030..e3e16e98 100644 --- a/docs/docs/installation.rst +++ b/docs/docs/installation.rst @@ -11,8 +11,16 @@ jedi-vim_ does by default), or you can install it systemwide. editor, refer to the corresponding documentation. -The preferred way ------------------ +The normal way +-------------- + +Most people use Jedi with a :ref:`editor plugins`. Typically +you install Jedi by installing an editor plugin. No necessary steps are needed. +Just take a look at the instructions for the plugin. + + +With pip +-------- On any system you can install |jedi| directly from the Python package index using pip:: diff --git a/jedi/api/classes.py b/jedi/api/classes.py index b0f44210..fb3cedac 100644 --- a/jedi/api/classes.py +++ b/jedi/api/classes.py @@ -329,7 +329,7 @@ class BaseDefinition(object): @memoize_method def params(self): """ - Raises an ``AttributeError``if the definition is not callable. + Raises an ``AttributeError`` if the definition is not callable. Otherwise returns a list of `Definition` that represents the params. """ # Only return the first one. There might be multiple one, especially