jquery / jquery/api.jquery.com
Fix documentation for JQUERY.AJAX() AND JSONP
Open
Nobody has claimed this yet.
help wanted
- Dominant language
- HTML
- Stars
- 325
- Forks
- 260
- PR merge metrics
- No merged PRs in 30d
Description
original ticket: http://bugs.jquery.com/ticket/12362
Related: http://bugs.jquery.com/ticket/
The above bug has been closed but the documentation is now misleading again for jQuery 1.8.0 (critically, 1.5+).
The documentation reads:
error This handler is not called for cross-domain script and JSONP requests.
timeout In Firefox 3.0+ only, script and JSONP requests cannot be cancelled by a timeout; the script will run even if it arrives after the timeout period.
Data types When data is retrieved from remote servers (which is only possible using the script or jsonp data types), the error callbacks and global events will never be fired.
Examples: http://jsfiddle.net/pte5g/14/
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 API documentation entries for error, timeout, and dataTypes, then run the linked jsFiddle example against the stated jQuery versions. Update the misleading statements so they match the observed cross-domain script and JSONP behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jquery
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100