Skip to content

Update definition of stop_id - #236

Merged
aababilov merged 2 commits into
google:masterfrom
aababilov:stop_id_location
May 19, 2021
Merged

Update definition of stop_id#236
aababilov merged 2 commits into
google:masterfrom
aababilov:stop_id_location

Conversation

@aababilov

Copy link
Copy Markdown
Contributor

Now we have generic nodes and boarding areas. Description of the location_type field is the canonical listing of all supported types.

@barbeau
barbeau requested a review from timMillet July 22, 2020 16:41
@tleboulenge

Copy link
Copy Markdown

If you want to keep to wording generic at that place and more specific close to the location_type field, I suggest moving the sentence "The term "station entrance" refers to both station entrances and station exits" over there.

The word "location" seems a bit vague (this word is used for moving vehicles in the RT spec). I assume to common denominator of these objects is that they can be the origin or destination of a routing path (and can be walked to or from)?

@sccmcca

sccmcca commented Sep 15, 2020

Copy link
Copy Markdown
Contributor

I'd like to suggest the exhaustive enumeration of all supported types to define what a "location" is. This would leave less ambiguity as to what a stop_id can represent, while removing the awkward sentence about what a "station entrance" is.

Something like:

Identifies a location: stop/platform, station, entrance/exit, generic node, or boarding area (see location_type).

Multiple routes may use the same stop_id.

@timMillet timMillet left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with @scmcca 's proposition. @aababilov How does it sound to you?

The word "location" may be vague; however, it is used many times (80+) in stops.txt, stop_times.txt, transfers.txt, pathways.txt to refer to a stop/platform, station, entrance/exit, generic node, or boarding area. So if "location" is removed or changed in the definition of stops.stop_id, it must be removed or changed anywhere else.

@sccmcca

sccmcca commented May 18, 2021

Copy link
Copy Markdown
Contributor

@timMillet IMHO it should be ok. The proposal is to generalize stop_id to match the generic use of the word "location" throughout the documentation.

In regards to the definition of "station entrance", I agree with @tleboulenge that, if defined as its own term, it should be defined once in the definition of location_type=2.

Alternatively, any reference to "station entrance" could be replaced with "location_type=2" to avoid describing the same thing in separate ways (i.e., limiting the interchange between informal naming and precise enum value... which makes the reader do more work). I think "station entrance" deserves some standardization throughout the documentation along with updating stop_id to the suggestion above. Thoughts?

aababilov added 2 commits May 19, 2021 11:12
Now we have generic nodes and boarding areas. Description of the location_type field is the canonical listing of all supported types.
@aababilov

Copy link
Copy Markdown
Contributor Author

Hi all,

Sorry, I have somehow missed that thread. Sure, the suggestion by @scmcca works for me and I have updated this PR.

@timMillet

@aababilov
aababilov requested a review from timMillet May 19, 2021 01:16
@sccmcca

sccmcca commented May 19, 2021

Copy link
Copy Markdown
Contributor

@aababilov Great! I just proposed a patch to this PR to also generalize the dataset file definition of stops.txt to make it consistent with updates in stop_id. It would read:

Stops where vehicles pick up or drop off riders. Also defines other locations related to station navigation.

Open to review. See the proposed patch here: aababilov#3

@aababilov

Copy link
Copy Markdown
Contributor Author

Thanks!

@aababilov
aababilov merged commit e7491e2 into google:master May 19, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants