Bulk convert comments above classes/functions/methods into proper docstrings

data/alert.py

@@ -10,9 +10,10 @@ from core.lookup_helper import lookup_helper
 from core.sig_utils import populate_sig_ref_info
 
 
-# Data class that defines an alert.
 @dataclass
 class Alert:
+    """Data class that defines an alert."""
+
     # Unique identifier for the alert
     id: str = None
     # Callsigns of the operators that has been alerted
@@ -60,8 +61,9 @@ class Alert:
     # The ID the source gave it, if any.
     source_id: str = None
 
-    # Infer missing parameters where possible
     def infer_missing(self):
+        """Infer missing parameters where possible"""
+
         # If we somehow don't have a start time, set it to zero so it sorts off the bottom of any list but
         # clients can still reliably parse it as a number.
         if not self.start_time:
@@ -122,14 +124,16 @@ class Alert:
         self_copy.received_time_iso = ""
         self.id = hashlib.sha256(str(self_copy).encode("utf-8")).hexdigest()
 
-    # JSON serialise
     def to_json(self):
+        """JSON serialise"""
+
         return json.dumps(self, default=lambda o: o.__dict__, sort_keys=True)
 
-    # Decide if this alert has expired (in which case it should not be added to the system in the first place, and not
-    # returned by the web server if later requested, and removed by the cleanup functions). "Expired" is defined as
-    # either having an end_time in the past, or if it only has a start_time, then that start time was more than 3 hours
-    # ago. If it somehow doesn't have a start_time either, it is considered to be expired.
     def expired(self):
+        """Decide if this alert has expired (in which case it should not be added to the system in the first place, and not
+        returned by the web server if later requested, and removed by the cleanup functions). "Expired" is defined as
+        either having an end_time in the past, or if it only has a start_time, then that start time was more than 3 hours
+        ago. If it somehow doesn't have a start_time either, it is considered to be expired."""
+
         return not self.start_time or (self.end_time and self.end_time < datetime.now(pytz.UTC).timestamp()) or (
                 not self.end_time and self.start_time < (datetime.now(pytz.UTC) - timedelta(hours=3)).timestamp())