From 9e4a1bce5f2cabc2132e6204a7700d19bf17685d Mon Sep 17 00:00:00 2001 From: Danilo Bargen Date: Thu, 27 Dec 2012 18:52:46 +0100 Subject: [PATCH 1/2] Fixed cross reference to exception --- docs/source/plugin-api.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/plugin-api.rst b/docs/source/plugin-api.rst index b19660c1..0b2cb110 100644 --- a/docs/source/plugin-api.rst +++ b/docs/source/plugin-api.rst @@ -5,7 +5,7 @@ The plugin API If you want to set up an editor/IDE-plugin with **Jedi**, you first need to ``import jedi``. You then have direct access to the :class:`.Script`, -:class:`.NotFoundError` and :func:`.set_debug_function` objects. +:exc:`.NotFoundError` and :func:`.set_debug_function` objects. API documentation From 59ff88ab57abff74f92af70f1f32106b7420f676 Mon Sep 17 00:00:00 2001 From: Danilo Bargen Date: Thu, 27 Dec 2012 18:52:56 +0100 Subject: [PATCH 2/2] Proper sphinx deprecation warning --- jedi/api_classes.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/jedi/api_classes.py b/jedi/api_classes.py index 1c949db6..0ce100d7 100644 --- a/jedi/api_classes.py +++ b/jedi/api_classes.py @@ -93,8 +93,8 @@ class BaseDefinition(object): @property def line_nr(self): """ - .. warning:: Deprecated! It's just here for backwards compatibility, - use `api_classes.BaseDefinition.line` instead. + .. deprecated:: 0.5.0 + Use :attr:`.line` instead. .. todo:: Remove! """ warnings.warn("Use line instead.", DeprecationWarning) @@ -102,7 +102,7 @@ class BaseDefinition(object): @property def line(self): - """ The line where the definition occurs (starting with 1). """ + """The line where the definition occurs (starting with 1).""" return self.start_pos[0] @property @@ -112,7 +112,7 @@ class BaseDefinition(object): @property def doc(self): - """ Return a document string for this completion object. """ + """Return a document string for this completion object.""" try: return self.definition.doc except AttributeError: