Improve discoverability of `satisfies`
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 52/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- java
- Domain
- documentation
Research direction
Start with the Soft Assertions section in the linked AssertJ documentation and review the linked satisfies Javadoc entry. Generalize the section to explain performing many assertions without stopping the test, then demonstrate how both satisfies and Soft Assertions address that challenge.
Written by the indexing model from the issue text.
Description
As of today, the documentation thoroughly explains how to use Soft Assertions, but there is no mention of satisfies, which can be a less intrusive option for simpler use cases.
We should generalize the section on Soft Assertions, describing the challenge of performing many assertions without stopping the test and demonstrating how satisfies and Soft Assertions can help solve it.
Related threads on BlueSky:
- 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 2/5 Half a day Newbie friendliness 35/100
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
Similar issues
-
Link Checker Report Openautomated issue report
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
Humanity AI Open
Difficulty 1/5 Under an hour Newbie friendliness 90/100
numfocus/project-fundraising#166 ·
-
area:proxy bug security severity:low track:open-source
Difficulty 2/5 1-3 hours Newbie friendliness 70/100