assertj / assertj/assertj-db

Document "data snapshot" aspect/intent of AbstractDbData and subclasses more explicitly

Aperta
#56 1 commento 0 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
Java
Stelle
130
Fork
21
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

Dear AssertJ-DB team, Dear Joel,

I found one of my friends wrapping Table to allow for a "data reload feature". As I understand the JavaDoc of that class, the intended purpose of this class and the sibling AbstractDbData subclasses is to hold a _snapshot_ of DB data and provide a fluent assertion API for this data _snapshot_.

The web site http://joel-costigliola.github.io/assertj/assertj-db-concepts.html states for e. g. Table and Request, that these objects represent a "Table *in*" or a "Request *on*" the database.

This probably misled my friend (who has a decent background in RDBMS) into thinking that a Table object could / should also be used in more complex query/update scenarios, whereas its original purpose is "only" to contain the data snapshot used for upcoming fluent assertions.

Would it be possible to make this intention of holding a _data snapshot_ from different sources (Table, Request) more explicit in the "Concepts" / "Elements of the Database" page, maybe a "Caution" paragraph elaborating a bit on this? In particular, I consider a hint like "If you need to re-load data after DB update operations, please create a new Table instance" very useful.

Looking forward to your feedback. Thanks in advance & keep up the good work. Very much appreciated.

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia con la documentazione Concepts / Elements of the Database e il JavaDoc di AbstractDbData e delle sue sottoclassi. Rendi espliciti lo scopo dello snapshot dei dati e l’indicazione di creare una nuova Table dopo gli aggiornamenti del database; il lavoro è completato quando è improbabile che i lettori interpretino Table come un oggetto dati ricaricabile.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
java
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
42/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.