jquery / jquery/api.jquery.com
Arguments accessible by .always(), .done() and .fail() from jQuery.ajax()
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 325
- Forks
- 260
- PR merge metrics
- No merged PRs in 30d
Description
Relates to: https://github.com/jquery/api.jquery.com/issues/49
The documentation is still badly formed. The docs for done(), always() etc.. should describe the params for the function. The page for .ajax is already long winded and I missed the snippet that was reproduced in alano999's post in the above issue.
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
Read the existing .ajax, .always(), .done(), and .fail() documentation, along with the related api.jquery.com issue, to understand the current callback descriptions. Done means the relevant method documentation clearly describes its callback parameters and the information is no longer easy to miss in the .ajax page.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jquery
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100