objectbox / objectbox/objectbox-java
API cleanup
Nessuno ha ancora preso questa issue.
- Lingua principale
- Java
- Stelle
- 4.6k
- Fork
- 311
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
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
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
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
Non vengono indicati file o test. Inizia individuando i simboli dell’API pubblica box.panicModeRemoveAll(), box.all2 e i metodi che contengono internal, quindi esamina come la libreria li espone. Per considerare concluso il lavoro, sarebbe necessario concordare l’ambito della pulizia e una denominazione pubblica coerente per l’API interessata.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- java
- Ambito
- api
- Tipo di issue
- Refactoring
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Da chiarire
- Idoneità per principianti
- 20/100