Update generate_image_metadata.py

add docstring
podaac · Jul 29, 2024 · 77d566c · 77d566c
1 parent 9c97fbc
commit 77d566c
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/bignbit/generate_image_metadata.py b/bignbit/generate_image_metadata.py
@@ -284,6 +284,19 @@ def extract_granule_dates(granule_umm_json: dict) -> (str, str, str, str):
 
 
 def parse_datetime(datetime_str: str) -> datetime:
+    """
+    Parses a datetime string into a datetime object.
+
+    Parameters
+    ----------
+    datetime_str
+      Datetime in str format to parse
+
+    Returns
+    -------
+    datetime
+      a datetime object
+    """
     try:
         return datetime.strptime(datetime_str, "%Y-%m-%dT%H:%M:%S.%fZ")
     except ValueError: