Merge pull request #53 from tkf/call-signature-in-completion

Call signature in Completion.doc
2012-11-04 15:35:43 -08:00
parent bfdfa67b97 5a20cd1665
commit 90a4a9240b
2 changed files with 32 additions and 2 deletions
--- a/jedi/api.py
+++ b/jedi/api.py
@@ -72,9 +72,14 @@ class Completion(object):

    @property
    def doc(self):
-        """ Returns the docstring `__doc__` for any object """
+        """ Return a document string for this completion object. """
        try:
-            return str(self.name.parent().docstr)
+            parent = self.name.parent()
+            try:
+                return '%s\n\n%s' % (parent.get_call_signature(),
+                                     parent.docstr)
+            except AttributeError:
+                return str(parent.docstr)
        except AttributeError:
            return ''