From 8f948495a414de65e3053ac381c41b4dbf02e829 Mon Sep 17 00:00:00 2001 From: Cora Grant Date: Fri, 12 Jul 2024 16:44:15 -0400 Subject: [PATCH] doc: correct descriptions of some section fields --- lib/config/v2/departures/layout.ex | 2 +- lib/config/v2/departures/section.ex | 5 ++--- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/lib/config/v2/departures/layout.ex b/lib/config/v2/departures/layout.ex index 609bd13..9f44550 100644 --- a/lib/config/v2/departures/layout.ex +++ b/lib/config/v2/departures/layout.ex @@ -9,7 +9,7 @@ defmodule ScreensConfig.V2.Departures.Layout do `max` and `min` as hard limits. If `max` is not set, the section may grow to fill all available space. If `base` is not set, it - defaults to the value of `max`. + defaults to the value of `min`. If `include_later` is set, the section includes a paging "Later Departures" component, which shows departures that would have otherwise been dropped due to space constraints (plus as many diff --git a/lib/config/v2/departures/section.ex b/lib/config/v2/departures/section.ex index de9854e..b832e9d 100644 --- a/lib/config/v2/departures/section.ex +++ b/lib/config/v2/departures/section.ex @@ -3,9 +3,8 @@ defmodule ScreensConfig.V2.Departures.Section do Configures a section within the Departures widget. Sections are a means of grouping departures by mode, stopping location, etc. Each section can fetch and display its departures differently. - - `bidirectional` enables a special mode that displays exactly two departures: the first one - that would normally be displayed, and the next departure on the same route in the opposite - direction. + - `bidirectional` enables a filter which enforces a maximum of 2 departures: the first that + would normally be displayed, and the next one in the opposite direction, if there is one. """ alias ScreensConfig.V2.Departures.{Filters, Header, Headway, Layout, Query}