add attrib-s description to Notification, NotificationEvent

Author: andrii-i

jupyter_scheduler/models.py

@@ -12,16 +12,28 @@
 
 
 class NotificationEvent(str, Enum):
-    """Enum representing events that should trigger a notification."""
+    """
+    Enum for events triggering notifications. Implementers can extend 
+    this enum to include additional notification events as needed.
 
+    Attributes:
+        SUCCESS (str): Sent when a job completes successfully.
+        FAILURE (str): Sent on job failure.
+        STOPPED (str): Sent when a job is manually stopped.
+    """
     SUCCESS = "Success"
     FAILURE = "Failure"
     STOPPED = "Stopped"
 
 
 class Notification(BaseModel):
-    """Represents a notification."""
-
+    """Represents a notification.
+    
+    Attributes:
+        send_to (List[str]): A list of symbols (e.g., email addresses) to which notifications should be sent.
+        events (List[NotificationEvent]): A list of events that should trigger the sending of notifications.
+        include_output (bool): A flag indicating whether a output should be included in the notification. Default is False.
+    """
     send_to: List[str]
     events: List[NotificationEvent]
     include_output: bool
@@ -32,7 +44,6 @@ class RuntimeEnvironment(BaseModel):
     execution will happen. For example, conda
     environment.
     """
-
     name: str
     label: str
     description: str