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

Fix names in docstrings and DeprecationWarnings.

Browse Source 
Update a number of docstrings and DeprecationWarnings to refer to
the correct methods or attributes.
This commit is contained in:
Jorgen Schaefer
2014-05-17 10:07:10 +02:00
parent c0064e17bc
commit 1cbbc00089
2 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
jedi/api/classes.py
View File

@@ -245,7 +245,7 @@ class BaseDefinition(object):
Use :meth:`.docstring` instead.
.. todo:: Remove!
"""
warnings.warn("Use documentation() instead.", DeprecationWarning)
warnings.warn("Use docstring() instead.", DeprecationWarning)
return self.docstring()
@property
@@ -255,7 +255,7 @@ class BaseDefinition(object):
Use :meth:`.docstring` instead.
.. todo:: Remove!
"""
warnings.warn("Use documentation() instead.", DeprecationWarning)
warnings.warn("Use docstring() instead.", DeprecationWarning)
return self.docstring(raw=True)
@property
@@ -463,7 +463,7 @@ class Completion(BaseDefinition):
:param fast: Don't follow imports that are only one level deep like
``import foo``, but follow ``from foo import bar``. This makes
sense for speed reasons. Completing `import a` is slow if you use
the ``foo.documentation(fast=False)`` on every object, because it
the ``foo.docstring(fast=False)`` on every object, because it
parses all libraries starting with ``a``.
"""
definition = self._definition