From f916b9b054acfe316238ee4e7d4ce633ef951d95 Mon Sep 17 00:00:00 2001 From: Dave Halter Date: Fri, 5 May 2017 09:21:42 +0200 Subject: [PATCH] More docstrings. --- jedi/parser/python/tree.py | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/jedi/parser/python/tree.py b/jedi/parser/python/tree.py index 46b503da..f8924d28 100644 --- a/jedi/parser/python/tree.py +++ b/jedi/parser/python/tree.py @@ -326,6 +326,10 @@ class Module(Scope): return False def get_used_names(self): + """ + Returns all the `Name` leafs that exist in this module. Tihs includes + both definitions and references of names. + """ if self._used_names is None: # Don't directly use self._used_names to eliminate a lookup. dct = {} @@ -356,9 +360,15 @@ class ClassOrFunc(Scope): @property def name(self): + """ + Returns the `Name` leaf that defines the function or class name. + """ return self.children[1] def get_decorators(self): + """ + :return list of Decorator: + """ decorated = self.parent if decorated.type == 'decorated': if decorated.children[0].type == 'decorators': @@ -387,6 +397,10 @@ class Class(ClassOrFunc): super(Class, self).__init__(children) def get_super_arglist(self): + """ + Returns the `arglist` node that defines the super classes. It returns + None if there are no arguments. + """ if self.children[2] != '(': # Has no parentheses return None else: