add comment for default circuit maintenance status

networktocode · Jan 3, 2025 · bb7432f · bb7432f
1 parent 0e3fa39
commit bb7432f
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/circuit_maintenance_parser/parsers/pccw.py b/circuit_maintenance_parser/parsers/pccw.py
@@ -56,6 +56,8 @@ class SubjectParserPCCW(EmailSubjectParser):
     This parser extracts maintenance ID, status and summary from the email subject line.
     """
 
+    # Only completion notification doesn't come with ICal. Other such as planned outage, urgent maintenance,
+    # amendment and cacellation notifications come with ICal. Hence, maintenance status is set to COMPLETED.
     DEFAULT_STATUS: ClassVar[Status] = Status.COMPLETED
 
     def parse_subject(self, subject: str) -> List[Dict]: