document source of truth for hiding subway times

mbta · Mar 26, 2024 · 5b68c59 · 5b68c59
1 parent e053a35
commit 5b68c59
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/shared/src/commonMain/kotlin/com/mbta/tid/mbta_app/model/StopAssociatedRoute.kt b/shared/src/commonMain/kotlin/com/mbta/tid/mbta_app/model/StopAssociatedRoute.kt
@@ -121,6 +121,7 @@ data class PatternsByHeadsign(
                 .map { Format.Some.FormatWithId(it, now) }
                 .filterNot {
                     it.format is UpcomingTrip.Format.Hidden ||
+                        // API best practices call for hiding scheduled times on subway
                         (this.route.type.isSubway() && it.format is UpcomingTrip.Format.Schedule)
                 }
                 .take(2)