From 557fe7169ad9202a23b261a022df131c15187b6c Mon Sep 17 00:00:00 2001 From: Denis Groshev Date: Thu, 12 Nov 2026 16:56:38 +0100 Subject: [PATCH] docs(application): the locale and rail path exports and the Rail and Transit read APIs are experimental Says so where the cockpit subject section names them, together with path.line, and that a snapshot read again while nothing changed is the one read before, so a provider may read one on every update. --- docs/APPLICATION.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/APPLICATION.md b/docs/APPLICATION.md index 3478aafc4..28f88e36c 100644 --- a/docs/APPLICATION.md +++ b/docs/APPLICATION.md @@ -306,7 +306,13 @@ Rail layer's pure path module (`createRailPath`, `pointAtS`, `projectOnPath`) for a provider placing a train along its line. The frame, HUD view and candidate fields are documented in `src/cockpitSubjectProviders.js`; the Rail and Transit read APIs in `src/layers/rail/cockpitSubject.js` and -`src/layers/transit/cockpitSubject.js`. +`src/layers/transit/cockpitSubject.js`. A snapshot read again while nothing in +it changed is the one read before, so `read` may take one on every update; a +train's `path.line` is a frozen copy of its line, for `pointAtS` and +`projectOnPath`. The `i18n/locale` and `layers/rail/paths` exports and the +Rail and Transit read APIs (`getSelectedTrain`, `getSelectedVehicle`, +`getCockpitSubject` and the snapshots they return, `path.line` among them) +are experimental and may change without notice. A candidate's `selectedAt` is a token that changes each time the user selects the subject, even the same one again, so entry takes it first. The Rail and