jquery / jquery/api.jquery.com
Clarify usage of ajax events with .on()
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 325
- Forks
- 260
- PR merge metrics
- No merged PRs in 30d
Description
The docs don't mention that .ajaxComplete() et al are actually aliases for triggered/triggerable events that can be attached with .on(),
Also, the language on these pages and the http://api.jquery.com/Ajax_Events/ page should be clarified now that the term "global event" doesn't apply. These events are triggered on document only. The Ajax Events page says the error and success callbacks are "local events" but that is confusing nomenclature, they aren't events in the DOM-event sense of the word.
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 Ajax Events page and the documentation pages for .ajaxComplete() and related Ajax event methods. Review how .on() attachment, document triggering, and the terms “global event” and “local events” are described. Done means the pages consistently explain these event relationships and use unambiguous terminology.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100