search

davidbau / seedrandom

seeded random number generator for Javascript
2.04k stars 160 forks source link

document the range or results #67

Open raould opened 4 years ago

raould commented 4 years ago

(hi, thanks for this library - very excited to be able to seed things, so e.g. if i try to make a game i can experiment with replaying things by reusing a seed.)

it would be great for a newbie coming to this library for the return values to be documented e.g. i /assume/ that double() returns something in the range 0...1, because that's often how other prng's work, but it isn't explicit that i could see in e.g. the readme. people like me who are easily confused would get a leg up with such clarifications. :-)

shanewholloway commented 3 years ago

I ended up documenting the seedrandom PRNG API and range a bit in the esm-seedrandom fork.

Would make a starting place for API docs in seedrandom, if you're motivated to change the import statements to require() expressions and test.