From 3cd7896ae1808d9a5442a7db2808bf784fb3d1f2 Mon Sep 17 00:00:00 2001
From: Justus Kuhlmann <justus@kuhl-mann.de>
Date: Thu, 12 Feb 2026 16:20:11 +0100
Subject: [PATCH] comment get_specs

---
 corrlib/input/sfcf.py | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/corrlib/input/sfcf.py b/corrlib/input/sfcf.py
index ed5a45a..6a75b72 100644
--- a/corrlib/input/sfcf.py
+++ b/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])