diff options
| author | Greg Titan <[email protected]> | 2022-05-23 11:01:53 -0700 |
|---|---|---|
| committer | GitHub <[email protected]> | 2022-05-23 20:01:53 +0200 |
| commit | a72f3d8e831623ad913d022398706fa5df3b56be (patch) | |
| tree | 2b4b69891d0dd8768e581472508ea33928257480 /src/modules | |
| parent | 2a6003f5fe15b79d361ed4f0d7b3c2b8ec98bfab (diff) | |
| download | faker-a72f3d8e831623ad913d022398706fa5df3b56be.tar.xz faker-a72f3d8e831623ad913d022398706fa5df3b56be.zip | |
docs: fix mersenne rand min max confusion (#839)
Co-authored-by: Shinigami92 <[email protected]>
Diffstat (limited to 'src/modules')
| -rw-r--r-- | src/modules/mersenne/index.ts | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/src/modules/mersenne/index.ts b/src/modules/mersenne/index.ts index 33e610f8..475c8836 100644 --- a/src/modules/mersenne/index.ts +++ b/src/modules/mersenne/index.ts @@ -22,12 +22,12 @@ export class Mersenne { /** * Generates a random number between `[min, max)`. * - * @param max The maximum number. Defaults to `0`. - * @param min The minimum number. Defaults to `32768`. + * @param max The maximum number. Defaults to `32768`. + * @param min The minimum number. Defaults to `0`. * * @example * faker.mersenne.rand() // 15515 - * faker.mersenne.rand(500, 1000) // 578 + * faker.mersenne.rand(1000, 500) // 578 */ rand(max = 32768, min = 0): number { if (min > max) { |