mapbox / mapbox/mapbox-navigation-android

Accept Locale instead of String in MapboxVoiceInstructionsPlayer and VoiceInstructionsTextPlayer

Open
#6,020 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

The strings are converted to Locale afterwards. It would make sense to accept Locale in the first place instead of specifying the format of a String in the docs.
I set the postponed group because it would break API, so it's not for now.

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

Locate MapboxVoiceInstructionsPlayer and VoiceInstructionsTextPlayer and read their current public signatures and documentation. Trace where the String is converted to Locale, then review the postponed API-compatibility concern before changing anything. Done means both APIs accept Locale consistently and their documentation no longer specifies a String format, with existing callers accounted for.

Written by the indexing model from the issue text.

Assessment

Tech stack
android, kotlin
Domain
api, mobile
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.