mapbox / mapbox/mapbox-base-android
Clarify documentation around module construction methods
Nessuno ha ancora preso questa issue.
- Lingua principale
- Kotlin
- Stelle
- 12
- Fork
- 6
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
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
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Leggi MODULARIZATION.md e la documentazione inline di module-loader per individuare la descrizione esistente della costruzione senza configurazione personalizzata. Chiarisci gli approcci pubblici supportati del costruttore senza argomenti, dell’object Kotlin e del singleton simile a Java, incluso il dettaglio static rimanente mostrato nell’issue. Il lavoro è completato quando entrambe le posizioni della documentazione spiegano questi approcci in modo coerente.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- kotlin
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 50/100