KDocs Issues in MapboxRouteArrowApi

Open Beginner friendly
#7,852 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
1-3 hours
Newbie friendliness
65/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
kotlin
Domain
documentation

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.

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)
Dominant language
Kotlin
Stars
651
Forks
321
No merged PRs in 30d

Contributor guide

Open the contributing guide

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 mapbox/mapbox-navigation-android

All issues in mapbox/mapbox-navigation-android

Similar issues

More Kotlin issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.