jquery / jquery/api.jquerymobile.com

.jqmData() and .jqmRemoveData() need to actually document their API

Open
#201 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
55
Forks
57
PR merge metrics
No merged PRs in 30d

Description

Directing users to api.jquery.com/data/ isn't good enough. There needs to be an actual signature documented.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the jQuery Mobile API documentation entries for .jqmData() and .jqmRemoveData() and compare them with the linked jQuery data API reference. Done means both methods have their own documented signatures rather than only a link to api.jquery.com/data/.

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
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.