jquery / jquery/api.jquery.com
Improve documentation for `converters`
Open
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 325
- Forks
- 260
- PR merge metrics
- No merged PRs in 30d
Description
There is no description what "text html": true does
Also extend the example:
$.ajaxSetup({
contents: {
mycustomtype: /mycustomtype/
},
converters: {
"mycustomtype json": function( result ) {
// Do stuff
return newresult;
}
}
});
by adding dataType: 'json', to be explicit that callback expects json format
Current documentation lead to missread. As result I get 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
Open the jQuery.ajax documentation linked in the issue and find the converters section. Clarify what "text html": true does and extend the shown $.ajaxSetup example with dataType: 'json'; done when both requested documentation changes are reflected accurately.
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
- Clearly specified
- Newbie friendliness
- 50/100