cleanup: Add a moduledoc for LegToSegmentHelper

mbta · Dec 11, 2024 · b200b37 · b200b37
1 parent 5caf9b7
commit b200b37
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/lib/dotcom/trip_plan/leg_to_segment_helper.ex b/lib/dotcom/trip_plan/leg_to_segment_helper.ex
@@ -1,4 +1,9 @@
 defmodule Dotcom.TripPlan.LegToSegmentHelper do
+  @moduledoc"""
+  A simple algorithm to convert legs as returned by Open Trip Planner
+  into segments to be displayed by our trip planner tool.
+  """
+
   alias Dotcom.TripPlan.{PersonalDetail, TransitDetail}
 
   def legs_to_segments(legs) do