VimPlug/jedi-fork
1
0
Fork 0
forked from VimPlug/jedi
Code Pull Requests Activity

Merge pull request #95 from dbrgn/docs

Browse Source 
Proper Sphinx deprecation warnings and cross references
This commit is contained in:
David Halter
2012-12-27 10:01:28 -08:00
parent 16236857bc 59ff88ab57
commit fc1d075a7c
2 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/source/plugin-api.rst
View File

@@ -5,7 +5,7 @@ The plugin API
If you want to set up an editor/IDE-plugin with **Jedi**, you first need to 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`, ``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 API documentation

8
jedi/api_classes.py
View File

@@ -93,8 +93,8 @@ class BaseDefinition(object):
@property @property
def line_nr(self): def line_nr(self):
""" """
.. warning:: Deprecated! It's just here for backwards compatibility, .. deprecated:: 0.5.0
use `api_classes.BaseDefinition.line` instead. Use :attr:`.line` instead.
.. todo:: Remove! .. todo:: Remove!
""" """
warnings.warn("Use line instead.", DeprecationWarning) warnings.warn("Use line instead.", DeprecationWarning)
@@ -102,7 +102,7 @@ class BaseDefinition(object):
@property @property
def line(self): 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] return self.start_pos[0]
@property @property
@@ -112,7 +112,7 @@ class BaseDefinition(object):
@property @property
def doc(self): def doc(self):
""" Return a document string for this completion object. """ """Return a document string for this completion object."""
try: try:
return self.definition.doc return self.definition.doc
except AttributeError: except AttributeError: