comment retruns of extract t0 and t1

corrlib/input/openQCD.py

@@ -190,6 +190,11 @@ def extract_t0(path: str, project: str, dir_in_project: str, param: dict[str, An
         Specific names for the replica of the ensemble the measurement file belongs to.
     files: list[str]
         Specific files to read.
+
+    Returns
+    -------
+    t0_dict: dict
+        Dictionary of t0 values in the pycorrlib style, with the parameters at hand.
     """
 
     dataset = os.path.join(path, "projects", project)
@@ -259,6 +264,11 @@ def extract_t1(path: str, project: str, dir_in_project: str, param: dict[str, An
         Specific names for the replica of the ensemble the measurement file belongs to.
     files: list[str]
         Specific files to read.
+
+    Returns
+    -------
+    t1_dict: dict
+        Dictionary of t1 values in the pycorrlib style, with the parameters at hand.
     """
 
     directory = os.path.join(path, "projects", project, dir_in_project)
@@ -289,7 +299,7 @@ def extract_t1(path: str, project: str, dir_in_project: str, param: dict[str, An
     for k in ["integrator", "eps", "ntot", "dnms"]:
         par_list.append(str(param[k]))
     pars = "/".join(par_list)
-    t0_dict: dict[str, Any] = {}
+    t1_dict: dict[str, Any] = {}
-    t0_dict[param["type"]] = {}
+    t1_dict[param["type"]] = {}
-    t0_dict[param["type"]][pars] = t0
+    t1_dict[param["type"]][pars] = t0
-    return t0_dict
+    return t1_dict

corrlib/input/sfcf.py

@@ -229,6 +229,24 @@ def _map_params(params: dict[str, Any], spec_list: list[str]) -> dict[str, Any]:
 
 
 def get_specs(key: str, parameters: dict[str, Any], sep: str = '/') -> str:
+    """
+    Get sepcification from the parameter file for a specific key in the read measurements
+
+    Parameters
+    ----------
+    key: str
+        The key for whioch the parameters are to be looked up.
+    parameters: dict[str, Any]
+        The dictionary with the parameters from the parameter file.
+    sep: str
+        Separator string for the key. (default="/")
+
+    Return
+    ------
+    s: str
+        json string holding the parameters.
+    """
+
     key_parts = key.split(sep)
     if corr_types[key_parts[0]] == 'bi':
         param = _map_params(parameters, key_parts[1:-1])