diff --git a/docs/readme.md b/docs/readme.md index ea55aa82..fa511bb8 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -4,7 +4,7 @@ - [`journeyLeg(ref, lineName, [opt])`](journey-leg.md) – get details for a leg of a journey - [`departures(station, [opt])`](departures.md) – query the next departures at a station - [`locations(query, [opt])`](locations.md) – find stations, POIs and addresses -- [`location(id)`](location.md) – get details about a location +- [`station(id)`](station.md) – get details about a station - [`nearby(location, [opt])`](nearby.md) – show stations & POIs around - [`radar(north, west, south, east, [opt])`](radar.md) – find all vehicles currently in a certain area diff --git a/docs/location.md b/docs/station.md similarity index 86% rename from docs/location.md rename to docs/station.md index 72cf9a40..1a0dd31b 100644 --- a/docs/location.md +++ b/docs/station.md @@ -1,9 +1,9 @@ -# `location(station)` +# `station(id)` -`station` must be in one of these formats: +`id` must be in one of these formats: ```js -// a station ID, in a format compatible to the profile you use +// a station ID, in a format compatible with the profile you use '900000123456' // an FPTF `station` object @@ -29,7 +29,7 @@ const vbbProfile = require('hafas-client/p/vbb') const client = createClient(vbbProfile) -client.location('900000042101') // U Spichernstr. +client.station('900000042101') // U Spichernstr. .then(console.log) .catch(console.error) ```