jquery / jquery/api.jquery.com
'Selector' type ambiguous
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 325
- Forks
- 260
- PR merge metrics
- No merged PRs in 30d
Description
From the Types page:
If Selector is specified as the type of an argument, it accepts everything that the jQuery constructor accepts, eg. Strings, Elements, Lists of Elements.
The jQuery constructor accepts Selector, Element, Array, PlainObject, and jQuery.
The definitions are conflicting. Does Selector really mean String when it's used throughout documentation or is the selector argument supposed to be of type String instead of Selector?
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 linked Types page and jQuery constructor documentation, comparing how “Selector” and the constructor’s accepted argument types are defined. Trace the uses of “Selector” in the documentation and clarify or standardize the terminology so the definitions no longer conflict.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jquery
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- Half a day
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100