Wiki: document stop routeIds ordering

Open Beginner friendly
#2,145 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 2 days

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
76/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
go
Domain
documentation

Research direction

Read the Stop-Records shared contract and stop.md, then check the stops-for-agency, stops-for-route, stops-for-location, and trips-for-* pages named in the issue. Add the routeIds ordering rule to the shared contract, using the comparator behavior described in the issue as the reference. Done when the shared contract documents natural sorting by short name, falling back to long name, for every stop record.

Written by the indexing model from the issue text.

Description

Only stop.md says how a stop's routeIds is ordered. The stops-for-agency, stops-for-route, stops-for-location and trips-for-* pages say nothing, though Java uses one comparator everywhere (natural sort by short name, falling back to long name; StopBeanServiceImpl.fillRoutesForStopBean).

A one-line rule in the Stop-Records shared contract would cover every place a stop record appears. Maglev follows that rule in most places since #2131.

Dominant language
Go
Stars
57
Forks
113
Avg merge
5d 10h
Merged PRs (30d)
151

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from OneBusAway/maglev

All issues in OneBusAway/maglev

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.