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

Aperta
#215 1 commento 1 reazione 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
Mezza giornata
Idoneità per principianti
35/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Ferma
Stack tecnologico
java
Ambito
documentation

Direzione di ricerca

Inizia leggendo l’issue 329 e la pull request 330 citati, quindi esamina le sezioni Quick start, Concepts e Release notes collegate in questa issue. Aggiorna le versioni delle dipendenze, le intestazioni, il testo, gli imports e gli esempi per spiegare che AssertJ Core assertions possono coesistere con AssertJ DB assertions e sono preferite, mantenendo al contempo le indicazioni di compatibilità per le versioni precedenti; aggiungi le note delle versioni 3.0.1 e 3.0.2.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
CSS
Stelle
26
Fork
32
Merge medio
1g 19h
PR unite (30g)
4

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di assertj/doc

Tutte le issue di assertj/doc

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.