-
Notifications
You must be signed in to change notification settings - Fork 100
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
docs: update #1009
docs: update #1009
Conversation
# Conflicts: # docs/NOTICES.md
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.
Thank you @lionel-nj for working on improving the existing documentation and adding what was missing! I left a few comments :)
RULES.md
Outdated
@@ -793,7 +803,7 @@ A route's color and `route_text_color` should be contrasting. | |||
|
|||
#### RouteShortAndLongNameEqualNotice | |||
|
|||
Short and long name are equal for a route. | |||
Short and long name are equal for a single route. |
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.
I propose to do the following to clarify the difference between DuplicateRouteNameNotice
and RouteShortAndLongNameEqualNotice
using the tables @aababilov made in issue 971.
RouteShortAndLongNameEqualNotice
- description in the table at the top of the document:
route_short_name and route_long_name are equal for a single route
- longer description below
A single route has the same values for route_short_name and route_long_name.
route_id route_short_name route_long_name route1 L1 L1
DuplicateRouteNameNotice
- description in the table at the top of the document:
Two routes have either the same
route_short_name
, the sameroute_long_name
, or the same combination ofroute_short_name
androute_long_name
.
- longer description below
Keep it as is but add:
route_id route_short_name route_long_name route1 U1 Southern route2 U1 Southern
Thanks for review @isabelle-dr, PTAL. |
Thanks for the update @lionel-nj, three more things that might have not have been very clear in my comment:
|
My bad @isabelle-dr, just updated the PR with the modifications you suggested. |
LGTM! Thanks |
Thanks for reviewing @isabelle-dr! |
Summary:
This PR updates rules documentation. This includes changes to:
RULES.md
NOTICES.md
RouteNameValidator.java
Expected behavior:
No code change, same tests should pass.
Please make sure these boxes are checked before submitting your pull request - thanks!
gradle test
to make sure you didn't break anything[ ] Include screenshot(s) showing how this pull request works and fixes the issue(s)