jquery / jquery/api.jquery.com
Incorrect signature of .ready() handler
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 325
- Forks
- 260
- PR merge metrics
- No merged PRs in 30d
Description
The reference documentation for .ready() handler does not specify any argument for the signature of the handler. However, the jQuery object is actually provided, which is quickly explained later in the section Aliasing the jQuery Object. This can be easily missed (like I did) and lead to writing incorrect code (like making jQuery triggering the ready event endlessly).
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 reference documentation section for the .ready() handler and compare its signature with the later “Aliasing the jQuery Object” explanation. Update the handler signature or nearby wording so the provided jQuery object is clear, then verify that the documentation consistently describes the argument and its usage.
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
- 55/100