From c34695ad4f19f6b0eaf19cf4e5b173b50c69a5f0 Mon Sep 17 00:00:00 2001
From: ahmedk <karim.ahmed@xfel.eu>
Date: Mon, 7 Mar 2022 12:16:54 +0100
Subject: [PATCH] fix docstring and add comments

---
 src/cal_tools/agipdlib.py | 1 +
 src/cal_tools/tools.py    | 3 ++-
 2 files changed, 3 insertions(+), 1 deletion(-)

diff --git a/src/cal_tools/agipdlib.py b/src/cal_tools/agipdlib.py
index de9a7db49..cb27f73a6 100644
--- a/src/cal_tools/agipdlib.py
+++ b/src/cal_tools/agipdlib.py
@@ -1266,6 +1266,7 @@ class AgipdCorrections:
             if when[cname]:
                 with h5py.File(mdata["file-path"], "r") as cf:
                     cons_data[cname]["data"] = np.copy(cf[f"{base_key}/data"])
+                    # The vairant attribute is missing for old constants.
                     if "variant" in cf[base_key].attrs.keys():
                         cons_data[cname]["variant"] = cf[base_key].attrs["variant"]  # noqa
             else:
diff --git a/src/cal_tools/tools.py b/src/cal_tools/tools.py
index 45e750b91..3f99b4560 100644
--- a/src/cal_tools/tools.py
+++ b/src/cal_tools/tools.py
@@ -602,6 +602,7 @@ def get_from_db(karabo_id: str, karabo_da: str,
                     )
                 with h5py.File(Path(hdf5path, filename), "r") as f:
                     metadata.calibration_constant.data = f[f"{h5path}/data"][()]  # noqa
+                    # The vairant attribute is missing for old constants.
                     if "variant" in f[h5path].attrs.keys():
                         metadata.calibration_constant_version.variant = (
                             f[h5path].attrs["variant"])
@@ -628,7 +629,7 @@ def send_to_db(db_module: str, karabo_id: str, constant, condition,
                ntries: int = 7,
                doraise: bool = False,
                variant: Optional[int] = None):
-    """Return calibration constants and metadata requested from CalDB
+    """Send new calibration constants and metadata requested to CalDB
 
     :param db_module: database module (PDU/Physical Detector Unit)
     :param karabo_id: karabo identifier
-- 
GitLab