Skip to content

Commit

Permalink
Corrected parameter documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
1ec5 committed Sep 3, 2020
1 parent fa18db8 commit bf1a130
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion Sources/MapboxDirections/Directions.swift
Original file line number Diff line number Diff line change
Expand Up @@ -392,8 +392,8 @@ open class Directions: NSObject {

- parameter responseIdentifier: The `RouteResponse.identifier` value of the `RouteResponse` that contains the route to refresh. You can alternatively use the value of `Route.routeIdentifier`.
- parameter routeIndex: The index of the route to refresh in the original `RouteResponse.routes` array.
- parameter startLegIndex: The index of the leg in the route at which to begin refreshing. The response will omit any leg before this index and refresh any leg from this index to the end of the route. If this argument is omitted, the entire route is refreshed.
- parameter completionHandler: The closure (block) to call with the resulting skeleton route data. This closure is executed on the application’s main thread.
- parameter startLegIndex: The index of the leg in the route at which to begin refreshing. If this argument is omitted, the entire route is refreshed.
- returns: The data task used to perform the HTTP request. If, while waiting for the completion handler to execute, you no longer want the resulting skeleton routes, cancel this task.
*/
@discardableResult open func refreshRoute(responseIdentifier: String, routeIndex: Int, fromLegAtIndex startLegIndex: Int = 0, completionHandler: @escaping RouteRefreshCompletionHandler) -> URLSessionDataTask? {
Expand Down

0 comments on commit bf1a130

Please sign in to comment.