jasmine / jasmine/jasmine.github.io
Better docs for custom spy strategies
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 573
- Forks
- 411
- PR merge metrics
- No merged PRs in 30d
Description
Right now all we have is https://jasmine.github.io/api/edge/jasmine.html#.addSpyStrategy which doesn't explain what a strategy is or what the factory should return. It would be good to have something that explains what custom spy strategies are useful for and how to write them.
Some context:
https://groups.google.com/g/jasmine-js/c/kdzzuNxOFEU/m/1pALAoT63EsJ
https://github.com/jasmine/jasmine/issues/279
https://github.com/jasmine/jasmine/issues/94
https://github.com/jasmine/jasmine/commit/4934e420b20bd4f6af3668ef06481c9dc7fecc33
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
Start with the existing addSpyStrategy API documentation and review the linked discussion, issues, and commit for the intended behavior. Done means the documentation explains what custom spy strategies are useful for, what the factory should return, and how to write one.
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
- 45/100