jquery / jquery/learn.jquery.com
Expand the Ajax Convenience Methods to talk about jqXHR and chainable error handling
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 915
- Forks
- 471
- PR merge metrics
- No merged PRs in 30d
Description
Separating out the second issue from issue #555 so a partial fix can be applied.
The first phrase in the Convenience Methods-section, however, says this:
If you don't need the extensive configurability of
$.ajax(), and you don't care about handling errors...
Handling the errors point is kinda misleading, as of jQuery 1.5. all jQuery Ajax-methods return a jqXHR-object, which is chainable with.error(),.done()and.always()(or as of 1.8 with.fail(),.done()and.always()), which makes using the convenience methods while handling error situations possible.
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 Convenience Methods section linked in the issue and review the quoted sentence about error handling. Update the explanation to acknowledge chainable jqXHR error handling, including the .error() API in jQuery 1.5 and .fail() in 1.8, then verify the revised documentation is accurate.
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