Document the distribution of `Phaser.Math.RND.weightedPick` inside its JSDoc
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 72/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Quiet
- Tech stack
- javascript
- Domain
- documentation
Research direction
Locate the JavaScript definition of Phaser.Math.RND.weightedPick and read its existing JSDoc alongside the shown selection formula. Update the JSDoc to explain precisely how the formula favors earlier array items, including the relevant distribution detail; done means the documented behavior matches the implementation.
Written by the indexing model from the issue text.
Description
Currently, the weightedPick function fails to mention precisely how much earlier items in the array are favored over later ones, which is a fairly important detail to simply omit without mention.
Admittedly, the provided code isn't the clearest in the world either...
weightedPick: function (array)
{
return array[~~(Math.pow(this.frac(), 2) * (array.length - 0.5) + 0.5)];
},
- Dominant language
- JavaScript
- Stars
- 40.3k
- Forks
- 7.2k
- PR merge metrics
- No merged PRs in 30d
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.
More from phaserjs/phaser
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
Difficulty 1/5 Under an hour Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
HarperFast/skills#96 ·
-
[Block] Latest Posts [Type] Bug
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Automattic/studio#4908 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
sugarlabs/musicblocks#8847 ·