Document "data snapshot" aspect/intent of AbstractDbData and subclasses more explicitly
- Vorherrschende Sprache
- Java
- Sterne
- 130
- Forks
- 21
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
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.
Beitragsleitfaden
Rechercherichtung
Beginnen Sie mit der Dokumentation zu Concepts / Elements of the Database und dem JavaDoc für AbstractDbData und seine Unterklassen. Machen Sie den Zweck des Daten-Snapshots und den Hinweis, nach Datenbankaktualisierungen eine neue Table zu erstellen, ausdrücklich; die Aufgabe ist abgeschlossen, wenn Leser Table wahrscheinlich nicht als neu ladbares Datenobjekt interpretieren.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- java
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 42/100