Document that org.assertj.core.api.Assertions is now directly usable
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- Half a day
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- java
- Domain
- documentation
Research direction
Start by reading the referenced issue 329 and pull request 330, then inspect the Quick start, Concepts, and Release notes sections linked in this issue. Update the dependency versions, headings, prose, imports, and examples to explain that AssertJ Core assertions can coexist with AssertJ DB assertions and are preferred, while retaining compatibility guidance for older versions; add the 3.0.1 and 3.0.2 notes.
Written by the indexing model from the issue text.
Description
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
- Dependency management - https://assertj.github.io/doc/#assertj-db-quickstart-dependency
- Both maven and gradle part should be updated with latest version
- How to use the static import - https://assertj.github.io/doc/#statically-import-org-assertj-db-api-assertions-assertthat
- Title of the paragraph
- Content of the paragraph itself
Concepts - Navigation
- With a Table or a Request as root - https://assertj.github.io/doc/#assertj-db-concepts-tableorrequestasroot
- The introductory phrase uses Assertions class full name
- Both samples of code for Table and Request have the static import
- With Changes as root - https://assertj.github.io/doc/#assertj-db-concepts-changesasroot
- Same as above
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.assertThatwith 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 bothAssertionsclass. - However I believe the feature makes
org.assertj.db.api.Assertions.assertThatirrelevant. And I think the documentation should make it clear thatorg.assertj.core.api.Assertions.assertThatis to be favored.
If documentation is open for contribution, I am willing to do a proposal.
- Dominant language
- CSS
- Stars
- 26
- Forks
- 32
- Avg merge
- 1d 19h
- Merged PRs (30d)
- 4
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from assertj/doc
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 52/100
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
agilepathway/label-checker#640 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
BasedHardware/omi#15662 · 1 comment ·
-
documentation help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
-
documentation good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
amponce/archive-movie-browser#167 ·
-
user-reported
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Kong/developer.konghq.com#7316 ·