From 20b65d1a9993f72384e8a3bf85e43960fff52c66 Mon Sep 17 00:00:00 2001
From: binh-dam-ibigroup <56846598+binh-dam-ibigroup@users.noreply.github.com>
Date: Wed, 29 Nov 2023 15:30:30 -0500
Subject: [PATCH] refactor(TripMonitorNotification): Add comment for
 comparator/sort function.

---
 .../middleware/models/TripMonitorNotification.java            | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/src/main/java/org/opentripplanner/middleware/models/TripMonitorNotification.java b/src/main/java/org/opentripplanner/middleware/models/TripMonitorNotification.java
index 82de2e9bf..273115270 100644
--- a/src/main/java/org/opentripplanner/middleware/models/TripMonitorNotification.java
+++ b/src/main/java/org/opentripplanner/middleware/models/TripMonitorNotification.java
@@ -24,6 +24,10 @@ public TripMonitorNotification(NotificationType type, String body) {
         this.body = body;
     }
 
+    /**
+     * Basic comparator that sets an arbitrary lower rank for initial reminders,
+     * so that they appear before other notifications after list sorting.
+     */
     public int sortOrder() {
         return type == NotificationType.INITIAL_REMINDER ? -100 : 0;
     }