jquery / jquery/api.jquery.com
.stop: document alternates using .clearQueue, .finish
Open
Nobody has claimed this yet.
help wanted
- Dominant language
- HTML
- Stars
- 325
- Forks
- 260
- PR merge metrics
- No merged PRs in 30d
Description
To avoid the "boolean trap" of the .stop() API we should mention the alternatives. The demo in .finish() shows what they are.
Contributor guide
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 .stop() API documentation and the .finish() demo mentioned in the issue. Document .clearQueue and .finish as alternatives to .stop(), with the work complete when the .stop() documentation explains these alternatives and links or points readers to them.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jquery
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 35/100