Fixed Required/Conditionally Required/Optional coding errors - #4
Fixed Required/Conditionally Required/Optional coding errors#4giocorti wants to merge 10 commits into
Conversation
|
@giocorti : Small thing, but can you remove the .DS_Store and any other invisible Mac OS files from the branch/PR? LGTM except for the .DS_Store. To confirm: The only change is the change of 4 fields from "Optional" to "Conditionally required". Can you list those fields in the pull request text? |
|
@giocorti: You should add |
|
@giocorti: Updating the gitignore works for the future, but do not remove the existing files. Sorry if my comment was misleading. You still have to remove the one you've already committed by hand. |
|
IMHO, before a PR is opened on the main google/transit repo the |
| | Field Name | Type | Required | Details | | ||
| | ------ | ------ | ------ | ------ | | ||
| | agency_id | ID | Optional | The **agency_id** field contains an ID that uniquely identifies a transit agency. A transit feed may represent data from more than one agency. This field is optional for transit feeds that only contain data for a single agency. | | ||
| | agency_id | ID | **Conditionally required** | The **agency_id** field contains an ID that uniquely identifies a transit agency. A transit feed may represent data from more than one agency. This field is optional for transit feeds that only contain data for a single agency. | |
There was a problem hiding this comment.
For each of these fields, I suggest we follow the following format in the Details field at the end of the description:
This field is required if..., otherwise it is optional.
There was a problem hiding this comment.
I've added the suggested language. Let me know what you think.
Specify when field is required
| | ------ | ------ | ------ | ------ | | ||
| | route_id | ID | **Required** | The **route_id** field contains an ID that uniquely identifies a route. | | ||
| | agency_id | ID | Optional | The **agency_id** field defines an agency for the specified route. This value is referenced from the [agency.txt](#agencytxt) file. Use this field when you are providing data for routes from more than one agency. | | ||
| | agency_id | ID | **Conditionally required** | The **agency_id** field defines an agency for the specified route. This value is referenced from the [agency.txt](#agencytxt) file. This field is required for feeds that contain more than one transit agency, otherwise it is optional. | |
There was a problem hiding this comment.
I'd suggest:
is required for feeds that contain more than one transit agency in agency.txt
| | | | | * **2** - Passenger may transfer twice. | | ||
| | | | | * **(empty)** - If this field is empty, unlimited transfers are permitted. | | ||
| | agency_id | ID | Optional | Required for feeds with multiple agencies defined in the agency.txt file. Each fare attribute must specify an agency_id value to indicate which agency the fare applies to. | | ||
| | agency_id | ID | **Conditionally required** | Required for feeds with multiple agencies defined in the agency.txt file. Each fare attribute must specify an agency_id value to indicate which agency the fare applies to. This field is required for feeds that contain more than one transit agency, otherwise it is optional.| |
|
LGTM |
|
LGTM, thanks @giocorti! |
# This is the 1st commit message: add tripupdate clarification # This is the commit message #2: fixed formatting # This is the commit message #3: Clarify detour description in service alerts Updated detour description for clarity. # This is the commit message #4: Clarify DETOUR effect description in reference.md Updated the description of the DETOUR effect to clarify that it refers to stops not being served. # This is the commit message #5: better detour definition
4 participants
The following fields have been recoded as Conditionally Required:
agency.txt:
agency_idstops.txt:
zone_idroutes.txt:
agency_idfare_attributes.txt:
agency_idstop_times.txt:
arrival_timeanddeparture_time