mapbox / mapbox/mapbox-navigation-android

NavigationMapRoute style documentation is outdated (style name changed)

Open
#3,502 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Kotlin
Stars
651
Forks
321
PR merge metrics
No merged PRs in 30d

Description

**Mapbox Navigation SDK version:**
Before:
```
implementation 'com.mapbox.navigation:ui-v1:1.0.0-SNAPSHOT'
implementation 'com.mapbox.navigation:core:1.0.0-rc.4'


```

After:

```
implementation 'com.mapbox.navigation:ui:1.0.0-rc.6'
implementation 'com.mapbox.navigation:core:1.0.0-rc.6'

<style name="mapbox_route" parent="MapboxStyleNavigationMapRoute">

```

### Steps to trigger behavior

1. Update to rc.6
2. See error that `NavigationMapRoute` does not exist anymore
3. Open `NavigationMapRoute.java`, read its docs, it says

>Inside your applications {@code style.xml} file, you extend {@code <style name="NavigationMapRoute">} [...]

### Expected behavior
Documentation is updated, should say "MapboxStyleNavigationMapRoute". I would also suggest to add something like ` <style name="mapbox_route" parent="MapboxStyleNavigationMapRoute">` as that makes it even more clear on how the extending works.

### Actual behavior
Documentation is not updated

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.

Research direction

Open NavigationMapRoute.java and find the style.xml documentation describing the NavigationMapRoute parent. Compare it with the rc.6 usage shown in the issue, including the mapbox_route style example. Done means the documentation names MapboxStyleNavigationMapRoute and clearly shows how to extend it.

Written by the indexing model from the issue text.

Assessment

Tech stack
android, java
Domain
documentation, mobile
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.