From 7e2a181520e793b5cacdc18c2240954800b20729 Mon Sep 17 00:00:00 2001 From: Leonard Ehrenfried Date: Mon, 16 Sep 2024 11:18:23 +0200 Subject: [PATCH] Improve Javadoc --- .../filters/system/OutsideSearchWindowFilter.java | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/src/main/java/org/opentripplanner/routing/algorithm/filterchain/filters/system/OutsideSearchWindowFilter.java b/src/main/java/org/opentripplanner/routing/algorithm/filterchain/filters/system/OutsideSearchWindowFilter.java index cbd47080c15..fe471484d1b 100644 --- a/src/main/java/org/opentripplanner/routing/algorithm/filterchain/filters/system/OutsideSearchWindowFilter.java +++ b/src/main/java/org/opentripplanner/routing/algorithm/filterchain/filters/system/OutsideSearchWindowFilter.java @@ -15,13 +15,17 @@ * Itineraries matching the start(earliest-departure-time) are included and itineraries matching * the end(latest-departure-time) are not. The filter is {@code [inclusive, exclusive]}. *

- * For arrive by searches, the street/flex-only results are treated differently: + * Arrive-by searches results are treated differently: + *

* Arrive-by transit result are filtered by their departure time and whether they don't depart * after the end of the computed search window which is dependent on the heuristic's minimum - * transit time. - * This doesn't work because street/flex-only can be shorter than the transit ones and often - * end up time-shifted right up to the arrive by time. + * transit time. This is identical to the depart-at searches. + *

+ * This doesn't work for street/flex-only because they can be shorter than the transit ones and often + * end up time-shifted right up to the arrive-by time. *

+ * For that reason the arrive-by street/flex-only results are only checked if they start after the + * latest-departure-time. * Further reading. */ public class OutsideSearchWindowFilter implements RemoveItineraryFlagger {