add comments according to coderabbit feedback

ls1intum · Nov 14, 2024 · 189b094 · 189b094
1 parent fbf2179
commit 189b094
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/app/domain/status/lecture_chat_status_update_dto.py b/app/domain/status/lecture_chat_status_update_dto.py
@@ -2,4 +2,10 @@
 
 
 class LectureChatStatusUpdateDTO(StatusUpdateDTO):
+    """Data Transfer Object for lecture chat status updates.
+        This DTO extends the base StatusUpdateDTO to include the result of lecture chat
+        pipeline operations, facilitating communication between Artemis and the lecture
+        chat system.
+    """
     result: str
+    """The result message or status of the lecture chat pipeline operation."""