google styled doc

mail_intake/exceptions.py

@@ -1,6 +1,10 @@
 """
 Exception hierarchy for Mail Intake.
 
+---
+
+## Summary
+
 This module defines the **canonical exception types** used throughout the
 Mail Intake library.
 
@@ -14,11 +18,12 @@ class MailIntakeError(Exception):
     """
     Base exception for all Mail Intake errors.
 
-    This is the root of the Mail Intake exception hierarchy.
-    All errors raised by the library must derive from this class.
+    Notes:
+        **Guarantees:**
 
-    Consumers should generally catch this type when handling
-    library-level failures.
+            - This is the root of the Mail Intake exception hierarchy
+            - All errors raised by the library must derive from this class
+            - Consumers should generally catch this type when handling library-level failures
     """
 
 
@@ -26,8 +31,10 @@ class MailIntakeAuthError(MailIntakeError):
     """
     Authentication and credential-related failures.
 
-    Raised when authentication providers are unable to acquire,
-    refresh, or persist valid credentials.
+    Notes:
+        **Lifecycle:**
+
+            - Raised when authentication providers are unable to acquire, refresh, or persist valid credentials
     """
 
 
@@ -35,8 +42,10 @@ class MailIntakeAdapterError(MailIntakeError):
     """
     Errors raised by mail provider adapters.
 
-    Raised when a provider adapter encounters API errors,
-    transport failures, or invalid provider responses.
+    Notes:
+        **Lifecycle:**
+
+            - Raised when a provider adapter encounters API errors, transport failures, or invalid provider responses
     """
 
 
@@ -44,6 +53,8 @@ class MailIntakeParsingError(MailIntakeError):
     """
     Errors encountered while parsing message content.
 
-    Raised when raw provider payloads cannot be interpreted
-    or normalized into internal domain models.
+    Notes:
+        **Lifecycle:**
+
+            - Raised when raw provider payloads cannot be interpreted or normalized into internal domain models
     """