From 6313934d9498c3546eb09550660391b8eacafdb6 Mon Sep 17 00:00:00 2001 From: Dave Halter Date: Tue, 4 Feb 2020 19:39:13 +0100 Subject: [PATCH] Add a docstring for is_side_effect --- jedi/api/classes.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/jedi/api/classes.py b/jedi/api/classes.py index 0456e7c3..37a403af 100644 --- a/jedi/api/classes.py +++ b/jedi/api/classes.py @@ -524,6 +524,10 @@ class BaseDefinition(object): return self._name.infer().get_type_hint() def is_side_effect(self): + """ + Checks if a name is defined as ``self.foo = 3``. In case of self, this + function would return False, for foo it would return True. + """ tree_name = self._name.tree_name if tree_name is None: return False