fix: update documentation to reflect correct seed range

kgryte · kgryte · commit 09483ae5cf6e · 2024-03-20T00:08:19.000-07:00
The seed for MT19937 must be a nonzero positive integer, as discussed in the original paper describing the Mersenne Twister PRNG. Closes: stdlib-js#1963
diff --git a/lib/node_modules/@stdlib/random/base/mt19937/README.md b/lib/node_modules/@stdlib/random/base/mt19937/README.md
@@ -60,9 +60,9 @@ The function accepts the following `options`:
 
 -   **seed**: pseudorandom number generator seed.
 -   **state**: a [`Uint32Array`][@stdlib/array/uint32] containing pseudorandom number generator state. If provided, the function ignores the `seed` option.
--   **copy**: `boolean` indicating whether to copy a provided pseudorandom number generator state. Setting this option to `false` allows sharing state between two or more pseudorandom number generators. Setting this option to `true` ensures that a returned generator has exclusive control over its internal state. Default: `true`.
+-   **copy**: boolean indicating whether to copy a provided pseudorandom number generator state. Setting this option to `false` allows sharing state between two or more pseudorandom number generators. Setting this option to `true` ensures that a returned generator has exclusive control over its internal state. Default: `true`.
 
-By default, a random integer is used to seed the returned generator. To seed the generator, provide either an `integer` on the interval `[0, 4294967295]`
+By default, a random integer is used to seed the returned generator. To seed the generator, provide either a nonzero integer on the interval `[1, 4294967295]`
 
 ```javascript
 var rand = mt19937.factory({
@@ -73,7 +73,7 @@ var r = rand();
 // returns 822569775
 ```
 
-or, for arbitrary length seeds, an array-like `object` containing unsigned 32-bit integers
+or, for arbitrary length seeds, an array-like object containing unsigned 32-bit integers
 
 ```javascript
 var Uint32Array = require( '@stdlib/array/uint32' );
