mapbox / mapbox/mapbox-base-android
Clarify documentation around module construction methods
Nobody has claimed this yet.
- Dominant language
- Kotlin
- Stars
- 12
- Forks
- 6
- PR merge metrics
- No merged PRs in 30d
Description
We should clarify the inline docs and https://github.com/mapbox/mapbox-base-android/blob/master/MODULARIZATION.md to make it clear what types of approaches will the module loader attempt when creating the object without a custom configuration. This means clarifying that it's compatible with:
- class with a public, no-arg constructor
- Kotlin object
- Java-like singleton with a static
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
Read MODULARIZATION.md and the inline module-loader documentation to identify the existing description of construction without custom configuration. Clarify the supported public no-arg constructor, Kotlin object, and Java-like singleton approaches, including the remaining static detail shown in the issue. Done means both documentation locations consistently explain these approaches.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- kotlin
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 50/100