[Clarification] from/to_stop_id & from/to_trip_id description in transfers.txt #455
Conversation
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
|
LGTM on the stop vs station change, however it should still be |
isabelle-dr
left a comment
There was a problem hiding this comment.
@tzujenchanmbd I made a few editorial edits for consistency with the rest pf the spec:
- having "Optional" not in bold
- enum values in
codeformatting - added a formatting change to
from_trip_idto reproduce into_trip_idto fit with the rest of the spec
|
It might be worth seeing if pieces of #363 could also be included in this PR. The initial scope of it was to revert transfer_type=4 and 5 but it also contained good editorial/clarification fixes. |
Co-authored-by: isabelle-dr <isabelle@mobilitydata.org>
Co-authored-by: isabelle-dr <isabelle@mobilitydata.org>
Co-authored-by: isabelle-dr <isabelle@mobilitydata.org>
gtfs/spec/en/reference.md
Outdated
| | ------ | ------ | ------ | ------ | | ||
| | `from_stop_id` | Foreign ID referencing `stops.stop_id` | **Conditionally Required** | Identifies a stop or station where a connection between routes begins. If this field refers to a station, the transfer rule applies to all its child stops. Refering to a station is forbiden for `transfer_types` 4 and 5. | | ||
| | `to_stop_id` | Foreign ID referencing `stops.stop_id` | **Conditionally Required** | Identifies a stop or station where a connection between routes ends. If this field refers to a station, the transfer rule applies to all child stops. Refering to a station is forbiden for `transfer_types` 4 and 5. | | ||
| | `from_stop_id` | Foreign ID referencing `stops.stop_id` | **Conditionally Required** | Identifies a stop (`location_type=0`) or a station (`location_type=1`) where a connection between routes begins. If this field refers to a station, the transfer rule applies to all its child stops. It must refer to a stop if `transfer_type` is `4` or `5`.<br><br>Conditionally Required:<br>- **Required** if `transfer_type` is `1`, `2`, or `3`.<br>- Optional if `transfer_type` is `4` or `5`. | |
There was a problem hiding this comment.
Nit: In the following statement:
It must refer to a stop if
transfer_typeis4or5
I would add (location_type=0) after "stop".
There was a problem hiding this comment.
Identifies a stop (
location_type=0) or a station (location_type=1) where a connection between routes begins.
This sentence should already limit to location_type 0 or 1 for this field.
Added "(location_type=0)" after the "stop" - e785501
isabelle-dr
left a comment
There was a problem hiding this comment.
One small comment, this LGTM.
|
This PR is solely for clarification purposes and does not alter any original meaning. However, since there are quite a few changes in wording, I am initiating a vote to confirm the descriptions with the community. Voting ends on 2024-09-17 at 23:59:59 UTC. |
|
+1 Transit |
|
+1 from Trillium |
|
+1 Maryland Transit Administration |
|
+1 OpenGeo |
|
The vote passed on 2024-09-17 at 23:59:59 UTC. 4 votes in favour and no votes against. Votes came from: Thank you to everyone who participated! |
|
The Canonical GTFS Validator V6.0.0 has fixed the unexpected behavior regarding this clarification. Please refer to the release page: https://github.com/MobilityData/gtfs-validator/releases/tag/v6.0.0. |
Issue
Recently we have received requests to change the behavior of the Canonical GTFS Validator regarding
transfers.from_stop_idandtransfers.to_stop_id(e.g. MobilityData/gtfs-validator#1621), stemming from different interpretations of the current specification.The current description of
from_stop_idis:Based on the description and the discussion in PR#303, it should indicate that
from_stop_idandto_stop_idcannot be empty, and it cannot be a "station" (location_type =1) iftransfer_typeis 4 or 5.However, some community members may interpret it as:
from_stop_idis required fortransfer_type1, 2, and 3; optional fortransfer_type4 and 5 ORfrom_stop_idis required fortransfer_type1, 2, and 3; forbidden fortransfer_type4 and 5To prevent such confusion from happening again, we propose the following modification:
Changes in this PR
Required- "The field or file must be included in the dataset and contain a valid value for each record", these 2 fields should beRequired.+@gcamp - the main contributor of PR#303