Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: correct descriptions of some section fields #29

Merged
merged 1 commit into from
Jul 15, 2024
Merged

doc: correct descriptions of some section fields #29

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/config/v2/departures/layout.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 2 additions & 3 deletions lib/config/v2/departures/section.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Expand Down
Loading