Start on use-case oriented documentation #38
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@provegard any thoughts on this style of documenting? |
provegard
reviewed
Nov 4, 2019
provegard
reviewed
Nov 4, 2019
docs/how-to-assert.md
Outdated
| > Avoid matching a collection on its length, as a failure will not give any details on the element(s) that were | ||
| > missing or extra. An alternative is to filter a larger list and match on a smaller inline list | ||
| > ```scala | ||
| > Example? |
There was a problem hiding this comment.
Difficult if you're after the length...
There was a problem hiding this comment.
Maybe just provide some tips? E.g.:
- Testing length may be brittle if the producer is modified to create more items - testing that the list contains some and not others (two tests) is likely more stable.
By the way, we could modify toHaveLength to print the actual list, or at least parts of it (like we need to do with toEqual/toContain).
|
Very nice! |
Co-Authored-By: Per Rovegård <[email protected]>
|
I'll merge this to master and we'll keep it up-to-date there on common scenarios. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What about adding another type of documentation, one that is use-case oriented?
E.g. show how to assert when you have a list. Give tips and tricks both regarding the Intent API as well as practices on writing good tests (regardless of framework)?
I think such a document would serve new users as well as developers new to TDD / testing well. Intention is to showcase common situations and let the API specification (or matchers.md) cover the details.
Related to #27