mafintosh / mafintosh/random-iterate
Document destruction of array
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 18
- Forks
- 2
- PR merge metrics
- No merged PRs in 30d
Description
Since the array is being modified I think that it would be good to document that.
Would you accept a pull request that changes the code to not modify the array?
Contributor guide
No contributing guide indexed for this repository
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 reading the package's array-iteration entry point to confirm whether the input array is modified. Document that behavior clearly, and check the existing comments or README for the appropriate documentation location. Done means users can see that iteration mutates the array and understand the behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- tooling
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100