jquery / jquery/learn.jquery.com
`Putting it Together` loses `Accepting Options`
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 915
- Forks
- 471
- PR merge metrics
- No merged PRs in 30d
Description
https://learn.jquery.com/plugins/basic-plugin-creation/
When trying to follow this article, it doesn't seem to have a consistent flow in that it appears to be starting with the basics, adding more information, then "Putting it together" as a conclusion to demonstrate the end result of how to write a basic jQuery plugin. However, the penultimate section "Accepting Options" is then not depicted in the code under the concluding "Putting it together" section. This makes the article less helpful, more confusing, than it could otherwise be.
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
Open the linked jQuery Learning Center article and compare the “Accepting Options” section with the concluding “Putting it together” example. Update the concluding example so it reflects the options support described earlier, then reread the article to confirm the progression is consistent.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 52/100