Add note about how optional messages work to documentation
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 2.3k
- Forks
- 115
- PR merge metrics
- No merged PRs in 30d
Description
I was glad to see that expect works with custom messages, but had to look at the code to see exactly how and when they are fired, and how I should format them in order to stay consistent with the library's style.
It might be good to add a note explaining the tense of the default messages ("expected x") and how the optional message replaces this one, and how this might be useful (e.g. giving more meaning than "expected false to be truthy")
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.
Research direction
Locate the documentation for expect assertions and custom messages, then review how the current examples describe default and optional messages. Done means adding a note covering the default-message tense, replacement behavior, formatting style, and why custom messages can add meaning.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100