phetsims / dot

A math library with a focus on mutable and immutable linear algebra for 2D and 3D applications.
MIT License
13 stars 6 forks source link

Add documentation in Random.js about where the seeds come from #62

Closed samreid closed 8 years ago

samreid commented 8 years ago

@pixelzoom recommended to add documentation in Random.js about where the seeds come from. Marking as high priority to add to my todo list.

samreid commented 8 years ago

The documentation for the random seeds currently reads:

    options = _.extend( {

      // {number|null} seed for the random number generator.  When seed is null, Math.random() is used.
      seed: null,

      // {boolean} if true, use the seed specified statically in `phet.chipper.randomSeed`.  This value is declared
      // in initialize-globals.js and can be overriden by PhET-iO for reproducible playback (see TPhETIO.setRandomSeed).
      staticSeed: false

    }, options );

I'm unsure what to add. @pixelzoom can you please help?

pixelzoom commented 8 years ago

Looks good. Closing.