Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Documentation: decreasing_or_equal_stop_time_distance explanatory text. #1225

Open
uq-bfitzpatrick opened this issue Aug 4, 2022 · 1 comment
Assignees
Labels
documentation Anything related to our documentation enhancement New feature request or improvement on an existing feature status: Work in progress A PR that would close this issue has been opened.

Comments

@uq-bfitzpatrick
Copy link

Hello,

If I have understood it correctly, I think that the explanation of this error in RULES.md could be improved.

This error seems to refer to fields expected in the file stop_times.txt rather than in the file stops.txt.
Consequently, the entry under References in RULES.md for this error could be updated to stop_times.txt.

This error seems to refer to the expected fields stop_sequence and shape_dist_traveled in the file stop_times.txt.
If so, the text explaining this error in RULES.md could be updated to include these field names for increased clarity.

That is, in the text:

"When sorted by stop_times.stop_pt_sequence, two consecutive stop times in a trip should have increasing distance. If the values are equal, this is considered as an error."

stop_times.stop_pt_sequence could be updated to stop_times.stop_sequence to match the specification here: https://gtfs.org/schedule/reference/#stop_timestxt

and

the phrase 'should have increasing distance' could be updated to refer to the field shape_dist_traveled by name.

Also, given that each row of stop_times.txt contains both an arrival_time and a departure_time, perhaps it would be clearer to refer to consecutive entries in this file rather than "consecutive stop times".

I think these changes would make the description of this error easier to understand.

Thanks again for this very useful tool.

@uq-bfitzpatrick uq-bfitzpatrick added the enhancement New feature request or improvement on an existing feature label Aug 4, 2022
@isabelle-dr isabelle-dr added status: Needs triage Applied to all new issues documentation Anything related to our documentation and removed enhancement New feature request or improvement on an existing feature labels Aug 4, 2022
@isabelle-dr isabelle-dr added status: Work in progress A PR that would close this issue has been opened. and removed status: Needs triage Applied to all new issues labels Aug 10, 2022
@isabelle-dr isabelle-dr self-assigned this Aug 10, 2022
@isabelle-dr
Copy link
Contributor

Hello @uq-bfitzpatrick, thank you for opening this issue 😊.
I have modified the reference file and the non-existent stop_pt_sequence field in #1234.
The last part is modifying the text to make it more clear, do you have a proposition for the definition you wish were there when you saw the issue the first time?

Thanks

@isabelle-dr isabelle-dr added the enhancement New feature request or improvement on an existing feature label Oct 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Anything related to our documentation enhancement New feature request or improvement on an existing feature status: Work in progress A PR that would close this issue has been opened.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants