From a2cd5ba187717a6a53f86e92c67908bc89533a91 Mon Sep 17 00:00:00 2001 From: Jannis R Date: Tue, 10 Jul 2018 19:01:40 +0200 Subject: [PATCH] docs & changelog for `includeRelatedStations` option :memo: see 1551943 --- docs/changelog.md | 1 + docs/departures.md | 3 +++ 2 files changed, 4 insertions(+) diff --git a/docs/changelog.md b/docs/changelog.md index c42ce562..2fcbe9ea 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -13,6 +13,7 @@ This version is not fully backwords-compatible. Check out [the migration guide]( - 84bce0c `arrivals()`/`departures()`: parse & expose platforms - 85e0bdf `journeys()`: `startWithWalking` option with default `true` - f6ae29c journey legs with `type: 'walking'` now have a `distance` in meters +- 1551943 `arrivals()`/`departures()`: `includeRelatedStations` option with default `true` ### breaking changes 💥 diff --git a/docs/departures.md b/docs/departures.md index 6008b524..3fa9dac6 100644 --- a/docs/departures.md +++ b/docs/departures.md @@ -29,6 +29,9 @@ With `opt`, you can override the default options, which look like this: duration: 10, // show departures for the next n minutes stationLines: false, // parse & expose lines of the station? remarks: true, // parse & expose hints & warnings? + // departures at related stations + // e.g. those that belong together on the metro map. + includeRelatedStations: true, language: 'en' // language to get results in } ```