jquery / jquery/api.jquery.com
jQuery.post is confusing regarding jqXHR error vs fail
Open
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 325
- Forks
- 260
- PR merge metrics
- No merged PRs in 30d
Description
The documentation for jQuery.post includes under "Additional Notes" the following:
- If a request with jQuery.post() returns an error code, it will fail silently unless the script has also called the global .ajaxError() method. Alternatively, as of jQuery 1.5, the .error() method of the jqXHR object returned by jQuery.post() is also available for error handling.
The same document notes earlier on that jqXHR.error() is deprecated and that .fail() should be used instead. Unless I'm mistaken, the above note should be updated to reflect this.
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 linked jQuery.post documentation and compare the Additional Notes text with the earlier jqXHR deprecation note. Update the error-handling reference so the page consistently names the current method, then verify that the surrounding wording remains accurate.
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
- 45/100