Add a few docstrings to make some things clearer

This commit is contained in:
Dave Halter
2019-08-02 13:16:18 +02:00
parent 876a6a5c22
commit a22c6da89f
2 changed files with 10 additions and 1 deletions

View File

@@ -621,6 +621,9 @@ class Signature(Definition):
@property @property
def params(self): def params(self):
"""
:return list of ParamDefinition:
"""
return [ParamDefinition(self._evaluator, n) return [ParamDefinition(self._evaluator, n)
for n in self._signature.get_param_names(resolve_stars=True)] for n in self._signature.get_param_names(resolve_stars=True)]
@@ -668,10 +671,15 @@ class CallSignature(Signature):
class ParamDefinition(Definition): class ParamDefinition(Definition):
def infer_default(self): def infer_default(self):
"""
:return list of Definition:
"""
return _contexts_to_definitions(self._name.infer_default()) return _contexts_to_definitions(self._name.infer_default())
def infer_annotation(self, **kwargs): def infer_annotation(self, **kwargs):
""" """
:return list of Definition:
:param execute_annotation: If False, the values are not executed and :param execute_annotation: If False, the values are not executed and
you get classes instead of instances. you get classes instead of instances.
""" """

View File

@@ -315,7 +315,8 @@ def test_signature_is_definition(Script):
# Now compare all the attributes that a CallSignature must also have. # Now compare all the attributes that a CallSignature must also have.
for attr_name in dir(definition): for attr_name in dir(definition):
dont_scan = ['defined_names', 'parent', 'goto_assignments', 'infer', 'params'] dont_scan = ['defined_names', 'parent', 'goto_assignments', 'infer',
'params', 'get_signatures']
if attr_name.startswith('_') or attr_name in dont_scan: if attr_name.startswith('_') or attr_name in dont_scan:
continue continue