docstrings
authorgwen <gremond@cadoles.com>
Fri, 10 May 2013 14:02:27 +0000 (16:02 +0200)
committergwen <gremond@cadoles.com>
Fri, 10 May 2013 14:02:27 +0000 (16:02 +0200)
tiramisu/autolib.py

index 60927af..a2714fd 100644 (file)
@@ -31,9 +31,6 @@ from tiramisu.i18n import _
 
 
 def carry_out_calculation(name, config, callback, callback_params):
-    # FIXME we have to know the exact status of the config
-    # not to disrupt it
-    # config.freeze()
     #callback, callback_params = option.getcallback()
     #if callback_params is None:
     #    callback_params = {}
@@ -113,4 +110,11 @@ def carry_out_calculation(name, config, callback, callback_params):
 
 
 def calculate(name, callback, params, tcparams):
+    """wrapper that launches the callback, that is a function
+    that carries out a calculation for an option's value
+
+    :param callback: callback name
+    :param params: in the callback's arity, the unnamed parameters
+    :params tcparams: in the callback's arity, the named parameters
+    """
     return callback(*params, **tcparams)