1
0
forked from VimPlug/jedi

api.Script.get_definition -> definition, to be consistent in the api naming. deprecated api.Script.get_definition

This commit is contained in:
David Halter
2013-02-21 22:12:51 +04:30
parent f8e0c78f77
commit b0c3fd5439
5 changed files with 41 additions and 31 deletions

View File

@@ -170,7 +170,7 @@ class Script(object):
x.word.lower()))
def _prepare_goto(self, goto_path, is_like_search=False):
""" Base for complete, goto and get_definition. Basically it returns
""" Base for complete, goto and definition. Basically it returns
the resolved scopes under cursor. """
debug.dbg('start: %s in %s' % (goto_path, self._parser.user_scope))
@@ -201,11 +201,20 @@ class Script(object):
return stmt
def get_definition(self):
"""
.. deprecated:: 0.5.0
Use :attr:`.function_definition` instead.
.. todo:: Remove!
"""
warnings.warn("Use line instead.", DeprecationWarning)
return self.definition()
def definition(self):
"""
Return the definitions of a the path under the cursor. This is not a
goto function! This follows complicated paths and returns the end, not
the first definition. The big difference between :meth:`goto` and
:meth:`get_definition` is that :meth:`goto` doesn't follow imports and
:meth:`definition` is that :meth:`goto` doesn't follow imports and
statements. Multiple objects may be returned, because Python itself is
a dynamic language, which means depending on an option you can have two
different versions of a function.