Skip to content

Commit 1ecfba5

Browse files
committed
improve docs
1 parent ef2e000 commit 1ecfba5

File tree

1 file changed

+1
-2
lines changed

1 file changed

+1
-2
lines changed

libnavigation-core/src/main/java/com/mapbox/navigation/core/MapboxNavigation.kt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -856,8 +856,7 @@ class MapboxNavigation @VisibleForTesting internal constructor(
856856
/***
857857
* Sets routes to preview.
858858
* Triggers an update in [RoutesPreviewObserver] and changes [MapboxNavigation.getRoutesPreview].
859-
* Routes preview requires async processing, so new routes won't be immediately available in [RoutesPreviewObserver] and [MapboxNavigation.getRoutesPreview].
860-
* Subscribe for updates using [MapboxNavigation.registerRoutesPreviewObserver] to receive new routes preview when processing will be completed.
859+
* Preview state is updated asynchronously as it requires the SDK to process routes and compute alternative metadata. Subscribe for updates using [MapboxNavigation.registerRoutesPreviewObserver] to receive new routes preview state when the processing will be completed.
861860
*
862861
* If [routes] isn't empty, the route with [primaryRouteIndex] is considered as primary, the others as alternatives.
863862
* To cleanup routes preview state pass an empty list as [routes].

0 commit comments

Comments
 (0)