Document "data snapshot" aspect/intent of AbstractDbData and subclasses more explicitly
- Lenguaje dominante
- Java
- Estrellas
- 130
- Forks
- 21
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
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.
Guía de contribución
Línea de trabajo
Comienza con la documentación de Concepts / Elements of the Database y el JavaDoc de AbstractDbData y sus subclases. Haz explícitos el propósito de la instantánea de datos y la indicación de crear una nueva Table después de las actualizaciones de la base de datos; se considerará terminado cuando sea poco probable que los lectores interpreten Table como un objeto de datos recargable.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- java
- Área
- documentation
- Tipo de issue
- Documentación
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 42/100