Document that org.assertj.core.api.Assertions is now directly usable

オープン
#215 コメント 1 件 リアクション 1 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
半日
初心者へのやさしさ
35/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
停滞
技術スタック
java
領域
documentation

調査の方向性

まず参照されている issue 329 と pull request 330 を読み、次にこの issue からリンクされている Quick start、Concepts、Release notes の各セクションを確認します。依存関係のバージョン、見出し、本文、imports、例を更新し、AssertJ Core assertions は AssertJ DB assertions と共存でき、推奨されることを説明するとともに、古いバージョン向けの互換性に関する案内を維持します。3.0.1 と 3.0.2 の注記を追加します。

索引モデルが issue の本文から書いたものです。

説明

Hello AssertJ DB

Following https://github.com/assertj/assertj-db/issues/329 and its PR https://github.com/assertj/assertj-db/pull/330

AssertJ DB Documentation should now mention that it is now possible for both AssertJ DB and AssertJ Core assertions to coexist in the same class with only one static import from AssertJ Core.

I took a look at the documentation to find occurences of the Assertions class full name.

Here are the candidates for modification that I found :

Quick start

Concepts - Navigation

Release notes - https://assertj.github.io/doc/#assertj-db-release-notes

  • Add the 3.0.2 - and the 3.0.1 for good measure

As for how, here are my thoughts :

  • Using org.assertj.core.api.Assertions.assertThat with previous versions of the library would not compile. So developers still using those should not have that as the only reference. So for now I believe the documentation should mention both Assertions class.
  • However I believe the feature makes org.assertj.db.api.Assertions.assertThat irrelevant. And I think the documentation should make it clear that org.assertj.core.api.Assertions.assertThat is to be favored.

If documentation is open for contribution, I am willing to do a proposal.

主要言語
CSS
スター
26
フォーク
32
平均マージ
1日 19時間
マージ済み PR(30日)
4

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

assertj/doc のほかの issue

assertj/doc の issue をすべて見る

似ている issue

Documentation の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。