objectbox / objectbox/objectbox-java
API cleanup
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Java
- Sterne
- 4.6k
- Forks
- 311
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
Good evening,
I think it would be productive to clean up the API around the library a bit.
There are for example numerous methods/variables that are rather confusing (e.g. box.panicModeRemoveAll() and box.all2), and quite a few calls include "internal" in their names even though they are public. Is there a reason for this?
Its not the end of the world, but I do think it would make a difference - and one of the things I appreciated with Realm earlier on was how everything had its place. You could never see any of its implementation details, and you could fully focus on creating awesome stuff.
Thanks!
Zoltan
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
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
Es werden keine Dateien oder Tests genannt. Beginne damit, die öffentlichen API-Symbole box.panicModeRemoveAll(), box.all2 und Methoden zu lokalisieren, die internal enthalten, und prüfe anschließend, wie die Bibliothek sie nach außen bereitstellt. Für den Abschluss wären ein abgestimmter Bereinigungsumfang und eine konsistente öffentliche Benennung für die betroffene API erforderlich.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- java
- Bereich
- api
- Issue-Typ
- Refactoring
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 20/100