add docstring

tnakazato · Feb 3, 2025 · 276b173 · 276b173
1 parent c3be719
commit 276b173
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/src/nro45data/psw/ms2/filler/data_description.py b/src/nro45data/psw/ms2/filler/data_description.py
@@ -14,6 +14,14 @@
 
 
 def _get_data_description_row(hdu: BinTableHDU) -> Generator[dict, None, None]:
+    """Provide data description row information.
+
+    Args:
+        hdu: NRO45m psw data in the form of BinTableHDU object.
+
+    Yields:
+        Dictionary containing data description row information.
+    """
     array_conf = get_array_configuration(hdu)
     ddd, _, _, _ = get_data_description_map(array_conf)
 
@@ -34,4 +42,10 @@ def _get_data_description_row(hdu: BinTableHDU) -> Generator[dict, None, None]:
 
 
 def fill_data_description(msfile: str, hdu: BinTableHDU):
+    """Fill MS DATA_DESCRIPTION table.
+
+    Args:
+        msfile: Name of MS file.
+        hdu: NRO45m psw data in the form of BinTableHDU object.
+    """
     fill_ms_table(msfile, hdu, "DATA_DESCRIPTION", _get_data_description_row)