jquery / jquery/api.jquery.com
Better document Deferred–thenable interactions
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 325
- Forks
- 260
- PR merge metrics
- No merged PRs in 30d
Description
(moved from https://github.com/jquery/jquery/issues/3646#issuecomment-306290209 )
Update https://api.jquery.com/jQuery.Deferred/ and https://api.jquery.com/deferred.resolve/ to clearly define the behavior of directly resolving a Deferred with a thenable, and https://api.jquery.com/deferred.then/ to define the result of returning a thenable from .then().
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 current documentation at api.jquery.com/jQuery.Deferred/, api.jquery.com/deferred.resolve/, and api.jquery.com/deferred.then/. Compare how each page currently describes thenables and identify the missing behavior for direct resolution and values returned from .then(); done means all three pages clearly define those interactions.
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
- 45/100