From 15d33ab7c4cee7d7edfddb2e0b400f8dd8162c3e Mon Sep 17 00:00:00 2001 From: Claude Date: Wed, 5 Aug 2026 20:26:12 +0000 Subject: [PATCH 1/3] docs: use `@name` JSDoc tag in `random/base/chisquare` The bound top-level PRNG in `lib/main.js` was documented with `@function chisquare`, deviating from the sampler convention. 32 of 33 distribution samplers (and 37 of 43 namespace members) tag the assigned generator with `@name`; only the PRNG engines (`minstd`, `minstd-shuffle`, `mt19937`) use `@function`. `chisquare` is a distribution sampler and its tag is paired with `@type {PRNG}`, so `@name` is the correct annotation. --- lib/node_modules/@stdlib/random/base/chisquare/lib/main.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/random/base/chisquare/lib/main.js b/lib/node_modules/@stdlib/random/base/chisquare/lib/main.js index 9f162268fba3..d9da1f3cea67 100644 --- a/lib/node_modules/@stdlib/random/base/chisquare/lib/main.js +++ b/lib/node_modules/@stdlib/random/base/chisquare/lib/main.js @@ -28,7 +28,7 @@ var factory = require( './factory.js' ); /** * Returns a pseudorandom number drawn from a chi-square distribution with degrees of freedom `k`. * -* @function chisquare +* @name chisquare * @type {PRNG} * @param {PositiveNumber} k - degrees of freedom * @returns {number} pseudorandom number From 93a9537a99fdc84bde59182d4def949a9f531b98 Mon Sep 17 00:00:00 2001 From: Claude Date: Wed, 5 Aug 2026 20:26:13 +0000 Subject: [PATCH 2/3] docs: annotate generator as `@type {PRNG}` in `random/base/rayleigh` The top-level generator in `lib/main.js` was annotated `@type {Function}`, the sole such case in the namespace. 40 of 43 namespace members annotate the `factory()`-returned generator with the more specific `@type {PRNG}`. `rayleigh` already uses `@name rayleigh`; the generic `{Function}` type is stale drift. --- lib/node_modules/@stdlib/random/base/rayleigh/lib/main.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/random/base/rayleigh/lib/main.js b/lib/node_modules/@stdlib/random/base/rayleigh/lib/main.js index 931f72e1eb56..e07de4413c35 100644 --- a/lib/node_modules/@stdlib/random/base/rayleigh/lib/main.js +++ b/lib/node_modules/@stdlib/random/base/rayleigh/lib/main.js @@ -29,7 +29,7 @@ var factory = require( './factory.js' ); * Returns a pseudorandom number drawn from a Rayleigh distribution with scale parameter `sigma`. * * @name rayleigh -* @type {Function} +* @type {PRNG} * @param {PositiveNumber} sigma - scale parameter * @returns {NonNegativeNumber} pseudorandom number * From 6b81172ecdeda0001fdb6acab4e4a77ce37a613a Mon Sep 17 00:00:00 2001 From: Claude Date: Wed, 5 Aug 2026 20:26:13 +0000 Subject: [PATCH 3/3] docs: correct `beta` parameter description in `random/base/gumbel` The `lib/validate.js` JSDoc documented `beta` as the "shape parameter", contradicting the package's own `lib/factory.js` and `lib/main.js` (both "scale parameter") and the scale-family sibling convention (invgamma, laplace, logistic, lognormal, weibull, frechet all document their positive scale parameter as "scale parameter"). The Gumbel distribution has only location and scale parameters, so "scale parameter" is correct. --- lib/node_modules/@stdlib/random/base/gumbel/lib/validate.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/random/base/gumbel/lib/validate.js b/lib/node_modules/@stdlib/random/base/gumbel/lib/validate.js index 6c46d0363342..3e6810070917 100644 --- a/lib/node_modules/@stdlib/random/base/gumbel/lib/validate.js +++ b/lib/node_modules/@stdlib/random/base/gumbel/lib/validate.js @@ -33,7 +33,7 @@ var isnan = require( '@stdlib/assert/is-nan' ); * * @private * @param {number} mu - mean -* @param {PositiveNumber} beta - shape parameter +* @param {PositiveNumber} beta - scale parameter * @returns {(Error|null)} error or null * * @example