Improve Documentation: decreasing_or_equal_stop_time_distance
explanatory text.
#1225
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.
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 filestops.txt
.Consequently, the entry under References in
RULES.md
for this error could be updated tostop_times.txt
.This error seems to refer to the expected fields
stop_sequence
andshape_dist_traveled
in the filestop_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 tostop_times.stop_sequence
to match the specification here: https://gtfs.org/schedule/reference/#stop_timestxtand
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 anarrival_time
and adeparture_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.
The text was updated successfully, but these errors were encountered: