-
Notifications
You must be signed in to change notification settings - Fork 183
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
Editorial changes to Reference.md #422
Conversation
These are all editorial changes and do not need a vote, although comments from the community are welcome! I will leave this PR open for a few days. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Thank you for the review @tzujenchanmbd! |
* Editorial changes to Reference.md (google#422) * Add dataset publishing in index * Fix link * Clarify stop_timezone description * Make references to other files consistent * fix link in Dataset Publishing Guidelines * Fix links * fix(gtfs/spec/reference): remove extra backtick in`record_id` description (google#431) * GTFS Trip-Modifications (google#403) * Add Trip-Modification, make shape non-experimental Fix typo Add images Update image width Add newlines Add newlines Update images Italic for image description Update SLO travel_time_to_stop is optional Proto : all feild optional Add references to GTFS-Static * Create a page for TripModifications entities for consistency with TU and VP * Clarify providing TUs for modified trips and ReplacementStop time interpolation Less strong requirement to interpolate * Fix first_stop_reference.png not having the right image + optimize image size. * Fix optional/require for Stop message * Clarify behaviour and linkage to TripUpdates * Apply Modification clarification proposed changes Co-authored-by: Paul Swartz <[email protected]> * Use ModifiedTripSelector instead of concatenation of IDs Update langage Update namign * Add details on behavior when is provided * Remove modifications_id * Fix after comments from @bdferris-v2 * Add note about producer needed the two versions of trip updates * Fix bad relationship mentionned, + force no other entity when using ModifiedTripSelector * Changes after Jan 10 call * Add experimental notices * Remove mention of stop pattern * Use stop selector instead of stop sequence only * Update to end_stop_selector * Update proto with start/end stop selector * Add selected trips * Update reference with SelectedTrips * Update trip modif doc * Add last_modified_time * Add missing start_times in pb * Fix typos, fix description of selected trips * Fix typos Co-authored-by: Nicholas Paun <[email protected]> * Update reference for clarity * Clarify and remove duplicated information * Consistancy * Revert correctly shape experimental * Editorial, formatting clarifications * Apply suggestions from @sam-hickey-ibigroup Co-authored-by: Sam Hickey <[email protected]> * Update documentation images with new fields, add source files * Clarifies behavior of propagated_modification_delay when no stop_time is cancelled * Remove extra word * Sync .proto and reference files --------- Co-authored-by: Nicholas Paun <[email protected]> Co-authored-by: Paul Swartz <[email protected]> Co-authored-by: Nicholas Paun <[email protected]> Co-authored-by: Joshua Fabian <[email protected]> Co-authored-by: Sam Hickey <[email protected]> * GTFS-Flex [Voting ver.] (google#433) * Add 3 "location" files and booking rules file * Modify stops.stop_id * Modify routes.continuous_pickup/drop_off * Modify stop_times.arrival/departure_time * Modify stop_times.stop_id * Add stop_times.location_group_id & location_id * Modify stop_times.stop_sequence * Add stop_times.start/end_pickup_drop_off_window * Modify pickup_type & drop_off_type * Modify stop_times.continuous_pickup/drop_off * Add pickup/drop_off_booking_rule_id * Add "On-demand Service Routing Behavior" * Modify conditions for start/end_pickup_drop_off_window * Remove unnecessary table name & editorial changes * [GTFS-Fares v2] Clarification: Fare product definition (google#426) * Clarify fare product definition * fare media clarification / remove desc in amount Add explicit interaction w/ fare media, Remove individual explanation in non-primary keys * Editorial change * Update gtfs/spec/en/reference.md Co-authored-by: isabelle-dr <[email protected]> * Update desc of fare_product_id Co-authored-by: isabelle-dr <[email protected]> * Editorial changes for fare_product_id * change "segments" to "legs" --------- Co-authored-by: isabelle-dr <[email protected]> * Update CHANGES.md (google#440) * Added data example page links in stop_times (google#443) --------- Co-authored-by: Kayla Firestack <[email protected]> Co-authored-by: Guillaume Campagna <[email protected]> Co-authored-by: Nicholas Paun <[email protected]> Co-authored-by: Paul Swartz <[email protected]> Co-authored-by: Nicholas Paun <[email protected]> Co-authored-by: Joshua Fabian <[email protected]> Co-authored-by: Sam Hickey <[email protected]> Co-authored-by: Tzu-Jen Chan <[email protected]>
In this PR, some small editorial changes.
Make all references to other files consistent.
Currently, the references to other files are mostly either (1) the the file name with a link to the file and no code formatting (e. g. fare_leg_rules.txt), or (2) file name with code formatting and no link (e. g.
fare_leg_rules.txt
). Given that (1) is more common though the spec document, I modified all (2) to (1).A change to the
stops.stop_timezone
description to better articulate the information written. The current description implies that the presence ofstops.stop_timezone
affects how values should be entered in stop_times.txt, which is false.Current:
Proposed:
Added the Dataset Publishing Guidelines that have been added recently in the index at the top of the doc and fixed a link in them.
Change the description of
calendar.service_id
to remove that the ID must be unique. Now that we have aUnique ID
field type, these mentions are not needed, andcalendar_service_id
is the only field in GTFS that still has it.