mapbox / mapbox/mapbox-navigation-android
KDocs Issues in MapboxRouteArrowApi
Nobody has claimed this yet.
- Dominant language
- Kotlin
- Stars
- 651
- Forks
- 321
- PR merge metrics
- No merged PRs in 30d
Description
In `com.mapbox.navigationcore:ui-maps:3.2.0`, the KDocs for `MapboxRouteArrowApi` have a couple of issues.
First, the initial code snippets show `withAboveLayerId()`, which is deprecated:
```
* RouteArrowOptions routeArrowOptions = new RouteArrowOptions.Builder(context)
* .withAboveLayerId(RouteLayerConstants.TOP_LEVEL_ROUTE_LINE_LAYER_ID)
* .build()
* MapboxRouteArrowApi routeArrow = new MapboxRouteArrowApi()
* MapboxRouteArrowView routeArrowView = new MapboxRouteArrowView(routeArrowOptions)
```
```
* val routeArrowOptions = RouteArrowOptions.Builder(context)
* .withAboveLayerId(RouteLayerConstants.TOP_LEVEL_ROUTE_LINE_LAYER_ID)
* .build()
* val routeArrow = MapboxRouteArrowApi()
* val routeArrowView = MapboxRouteArrowView(routeArrowOptions)
```
Also, the final code snippet shows a `updateUpcomingManeuverArrow()` that does not exist:
```
* override fun onRouteProgressChanged(routeProgress: RouteProgress) {
* val updateState = routeArrow.updateUpcomingManeuverArrow(routeProgress)
* routeArrowView.render(mapboxMap.getStyle(), updateState)
```
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Find the KDocs for MapboxRouteArrowApi and inspect the examples using withAboveLayerId() and updateUpcomingManeuverArrow(). Check the current RouteArrowOptions and MapboxRouteArrowApi APIs, then update the snippets to use available, non-deprecated calls; done means the examples no longer reference either reported issue.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- kotlin
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 65/100