api [nfc]: Add warning about a list not being sorted

As Greg suggests: zulip#304 (comment)
chrisbobbe · Oct 19, 2023 · 7ff3ac2 · 7ff3ac2
1 parent e4e5705
commit 7ff3ac2
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/lib/api/model/initial_snapshot.dart b/lib/api/model/initial_snapshot.dart
@@ -227,7 +227,10 @@ class UnreadMessagesSnapshot {
 
   final List<UnreadStreamSnapshot> streams;
   final List<UnreadHuddleSnapshot> huddles;
+
+  // Unlike other lists of message IDs here, [mentions] is *not* sorted.
   final List<int> mentions;
+
   final bool oldUnreadsMissing;
 
   UnreadMessagesSnapshot({