Document "data snapshot" aspect/intent of AbstractDbData and subclasses more explicitly
まだ誰も着手していません。
評価
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 初心者へのやさしさ
- 42/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- java
調査の方向性
Concepts / Elements of the Database のドキュメントと、AbstractDbData およびそのサブクラスの JavaDoc から始めます。データスナップショットの目的と、データベースの更新後に新しい Table を作成するための指針を明確にします。読者が Table を再ロード可能なデータオブジェクトとして解釈する可能性が低くなれば完了です。
索引モデルが issue の本文から書いたものです。
説明
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.
- 主要言語
- Java
- スター
- 130
- フォーク
- 21
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
assertj/assertj-db のほかの issue
-
Add toString() and equals() implementations for core domain types (Table, Row, Value, Column)再び着手できるかも @VanRoy が 295 日前に担当しましたが、オープン中のプルリクエストはありません。 オープン
assertj/assertj-db#324 · コメント 1 件 · 担当者 1 名 ·
-
question
難易度 3/5 1〜2日 初心者へのやさしさ 32/100
assertj/assertj-db#292 · コメント 1 件 ·
-
question
難易度 3/5 1〜2日 初心者へのやさしさ 35/100
assertj/assertj-db#290 · コメント 1 件 ·
-
難易度 4/5 3〜5日 初心者へのやさしさ 30/100
assertj/assertj-db#259 · コメント 1 件 ·
-
難易度 5/5 1週間以上 初心者へのやさしさ 25/100
assertj/assertj-db#206 ·
assertj/assertj-db の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
grimmory-tools/grimmory#2850 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 90/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
aoqia194/leaf-loader#19 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
apache/streampark#4521 ·
-
Update license yearオープン0 - Backlog 1 - Ready documentation good first issue help wanted
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100