jquery / jquery/api.jquery.com
Standard/automated markup for deprecated or removed API functionality
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 325
- Forks
- 260
- PR merge metrics
- No merged PRs in 30d
Description
Right now it's easy to overlook that some API is deprecated or removed, for example the .load() method. Sometimes it's best to add explicit wording, for example jQuery.unique() is replaced by jQuery.uniqueSort(). However it would be nice to have some sort of standard visual for these APIs. Is a modal or inline dialog that can be dismissed/collapsed too intrusive? Perhaps a watermark?
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 by reviewing the API documentation examples for the deprecated .load() method and the replacement guidance for jQuery.unique() and jQuery.uniqueSort(). Define a consistent visual treatment for deprecated or removed APIs, then document or demonstrate the agreed behavior; the issue does not name files or tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jquery
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100