mapbox / mapbox/mapbox-navigation-android

Make RouteShield#toBitmap return an Expected

Open
#5,451 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

`RouteShield#toBitmap` returns a nullable type which makes it hard to understand the reason for the failed parsing/processing in case it happens. We might want to consider introducing another functions that returns `Expected` instead or refactor the existing function with the next semver release.

cc @abhishek1508

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

Start by locating RouteShield#toBitmap and reviewing its current nullable return contract and the parsing or processing failures it can represent. The issue leaves open whether to add an Expected-returning function or change the existing API in the next semver release, so completion requires settling that API direction and documenting the resulting behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
kotlin
Domain
mobile
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.