Skip to content

Commit

Permalink
feat(path details): revise javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
ansoncfit committed Mar 5, 2024
1 parent d739e25 commit 8999be6
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions src/main/java/com/conveyal/r5/transit/path/RouteSequence.java
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,12 @@ public RouteSequence(PatternSequence patternSequence, TransitLayer transitLayer)
/**
* Returns details summarizing this route sequence, using GTFS ids stored in the supplied transitLayer.
* @param csvOptions indicates whether names or IDs should be returned for certain fields.
* @return array of pipe-concatenated strings, with the route, board stop, alight stop, ride time, and feed for
* each transit leg, as well as the access and egress time.
*
* If csvOptions.feedRepresentation is not null, the feed values will be R5-generated UUID for boarding stop of
* each leg. We are grabbing the feed ID from the stop rather than the route (which might seem like a better
* representative of the leg) because stops happen to have a readily available feed ID.
*/
public String[] detailsWithGtfsIds (TransitLayer transitLayer, CsvResultOptions csvOptions){
StringJoiner routeJoiner = new StringJoiner("|");
Expand Down

0 comments on commit 8999be6

Please sign in to comment.