splice documentation change?
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 24k
- Forks
- 3.8k
- Avg merge
- 3d 16h
- Merged PRs (30d)
- 25
Description
Topic
I find it confusing that splice is used to add and also remove something from an array. I know this is a Javascript problem not a P5 problem, but the p5 documentation only describes the adding feature, not the removing.
It would be great if the documentation could include this.
splice(listName, 0, 1) // adds "0" to the listName array at position 1.
listName.splice(0, 1); //removes one item from the array at position 0.
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
Locate the p5.js documentation entry for splice and review how it currently describes adding items. Update the documentation to cover removing items as well, using the issue's examples as the requested behavior. Done means the splice documentation explains both operations clearly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100