mapbox / mapbox/mapbox-base-android
Clarify documentation around module construction methods
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Kotlin
- Sterne
- 12
- Forks
- 6
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
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
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Lies MODULARIZATION.md und die Inline-Dokumentation zu module-loader, um die bestehende Beschreibung der Konstruktion ohne benutzerdefinierte Konfiguration zu identifizieren. Kläre die unterstützten Ansätze mit einem öffentlichen parameterlosen Konstruktor, einem Kotlin object und einem Java-ähnlichen Singleton, einschließlich des verbleibenden statischen Details, das im Issue gezeigt wird. Erledigt ist dies, wenn beide Dokumentationsstellen diese Ansätze konsistent erklären.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- kotlin
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 50/100