VimPlug/jedi
1
0
Fork 1
mirror of https://github.com/davidhalter/jedi.git synced 2025-12-09 23:34:45 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #411 from jorgenschaefer/fix-deprecation-docstring-typo

Browse Source 
Fix deprecation docstring typo
This commit is contained in:
Dave Halter
2014-05-17 13:04:45 +04:30
parent c0064e17bc 1cbbc00089
commit 41f32f21ea
2 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
jedi/api/__init__.py
View File

@@ -345,7 +345,7 @@ class Script(object):
Use :attr:`.call_signatures` instead. Use :attr:`.call_signatures` instead.
.. todo:: Remove! .. todo:: Remove!
""" """
warnings.warn("Use line instead.", DeprecationWarning) warnings.warn("Use call_signatures instead.", DeprecationWarning)
sig = self.call_signatures() sig = self.call_signatures()
return sig[0] if sig else None return sig[0] if sig else None

6
jedi/api/classes.py
View File

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