assertj / assertj/assertj-db

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

Ouverte
#56 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub
Langage dominant
Java
Étoiles
130
Forks
21
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

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.

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Commencez par la documentation Concepts / Elements of the Database et le JavaDoc de AbstractDbData et de ses sous-classes. Rendez explicites la finalité de l’instantané de données et l’indication de créer une nouvelle Table après les mises à jour de la base de données ; le travail est terminé lorsque les lecteurs sont peu susceptibles d’interpréter Table comme un objet de données rechargeable.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
java
Domaine
documentation
Type d'issue
Documentation
Difficulté
2/5
Temps estimé
1-3 heures
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
42/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.