Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

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

Aperta
#56 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

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

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.

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.

Lingua principale
Java
Stelle
130
Fork
21
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di assertj/assertj-db

Tutte le issue di assertj/assertj-db

Issue simili

Altre issue su Java

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.