docs

mbta · Dec 5, 2024 · 15934a1 · 15934a1
1 parent 989b474
commit 15934a1
Showing 1 changed file with 13 additions and 2 deletions.
diff --git a/lib/dotcom_web/components/trip_planner/walking_leg.ex b/lib/dotcom_web/components/trip_planner/walking_leg.ex
@@ -1,6 +1,7 @@
 defmodule DotcomWeb.Components.TripPlanner.WalkingLeg do
   @moduledoc """
-
+  A walking leg of a trip.
+  Includes a summary of the walk (time and distance) and a list of steps.
   """
 
   use Phoenix.Component
@@ -11,7 +12,17 @@ defmodule DotcomWeb.Components.TripPlanner.WalkingLeg do
 
   alias OpenTripPlannerClient.Schema.Step
 
-  attr :leg, :map
+  @doc """
+  Renders a walking leg.
+
+  Must be given a `leg` with a:
+    - `distance` (float) in miles
+    - `duration` (integer) in minutes
+    - `mode` with a list of `steps` (list of `Step` structs)
+    - `polyline` (string) to use as the accordion ID
+  """
+
+  attr :leg, :map, required: true
 
   def walking_leg(assigns) do
     ~H"""