add comment for pattern

tardis-sn · Nov 13, 2024 · c39c8b4 · c39c8b4
1 parent 1a2cfe4
commit c39c8b4
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/carsus/io/vald/vald.py b/carsus/io/vald/vald.py
@@ -166,7 +166,9 @@ def read_vald_raw(self, fname=None):
         # Elm Ion       WL_air(A)  log gf* E_low(eV) J lo  E_up(eV) J up   lower   upper    mean   Rad.  Stark    Waals
         # 'TiO 1',     4100.00020, -11.472,  0.2011, 31.0,  3.2242, 32.0, 99.000, 99.000, 99.000, 6.962, 0.000, 0.000,
 
-        DATA_RE_PATTERN = re.compile(r"'[a-zA-Z]+\d* \d+',[\s*-?\d+[\.\d+]+,]*")
+        DATA_RE_PATTERN = re.compile(
+            r"'[a-zA-Z]+\d* \d+',[\s*-?\d+[\.\d+]+,]*"
+        )  # This matches to the Elm Ion field of the format above (e.g., TiO 1 or C 2)
 
         buffer, checksum = read_from_buffer(self.fname)
         content = buffer.read().decode()