From addcf87fee00c6e55c04c9fc460da252b85f590d Mon Sep 17 00:00:00 2001 From: Claude Date: Tue, 2 Jun 2026 16:19:38 +0000 Subject: [PATCH] docs: correct `mu` description and `b` JSDoc type in `stats/base/dists/laplace/mgf` Normalized JSDoc parameter descriptions in `lib/main.js`, `lib/factory.js`, `lib/native.js`, and `docs/types/index.d.ts` to match the rest of the `stats/base/dists/laplace/` namespace: - Changed `@param {NonNegativeNumber} b` to `@param {PositiveNumber} b` (13/14 sibling function packages use `{PositiveNumber}`; the implementation rejects `b <= 0.0` and the README documents that `b <= 0` returns `NaN`, so `NonNegativeNumber` was incorrect). - Changed `@param {number} mu - mean` to `@param {number} mu - location parameter` (every other `@param mu` occurrence in the namespace uses "location parameter"; the same `docs/types/index.d.ts` already uses "location parameter" in its top-level description, so the interface declarations were internally inconsistent). No behavior changes; no test or example updates required. https://claude.ai/code/session_01Cv7Lh8wtQoKzrem6gXstiK --- .../stats/base/dists/laplace/mgf/docs/types/index.d.ts | 4 ++-- .../@stdlib/stats/base/dists/laplace/mgf/lib/factory.js | 4 ++-- .../@stdlib/stats/base/dists/laplace/mgf/lib/main.js | 4 ++-- .../@stdlib/stats/base/dists/laplace/mgf/lib/native.js | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/laplace/mgf/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/dists/laplace/mgf/docs/types/index.d.ts index 32019ca438f3..21b299b87617 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/laplace/mgf/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/dists/laplace/mgf/docs/types/index.d.ts @@ -38,7 +38,7 @@ interface MGF { * - If provided `b <= 0`, the function returns `NaN`. * * @param t - input value - * @param mu - mean + * @param mu - location parameter * @param b - scale parameter * @returns evaluated MGF * @@ -87,7 +87,7 @@ interface MGF { /** * Returns a function for evaluating the moment-generating function (MGF) of a Laplace (double exponential) distribution with location parameter `mu` and scale parameter `b`. * - * @param mu - mean + * @param mu - location parameter * @param b - scale parameter * @returns MGF * diff --git a/lib/node_modules/@stdlib/stats/base/dists/laplace/mgf/lib/factory.js b/lib/node_modules/@stdlib/stats/base/dists/laplace/mgf/lib/factory.js index a1d09f5c30a5..25d3e40ac992 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/laplace/mgf/lib/factory.js +++ b/lib/node_modules/@stdlib/stats/base/dists/laplace/mgf/lib/factory.js @@ -32,8 +32,8 @@ var pow = require( '@stdlib/math/base/special/pow' ); /** * Returns a function for evaluating the moment-generating function (MGF) of a Laplace (double exponential) distribution with location parameter `mu` and scale parameter `b`. * -* @param {number} mu - mean -* @param {NonNegativeNumber} b - scale parameter +* @param {number} mu - location parameter +* @param {PositiveNumber} b - scale parameter * @returns {Function} MGF * * @example diff --git a/lib/node_modules/@stdlib/stats/base/dists/laplace/mgf/lib/main.js b/lib/node_modules/@stdlib/stats/base/dists/laplace/mgf/lib/main.js index 0013df687915..10611dc389ea 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/laplace/mgf/lib/main.js +++ b/lib/node_modules/@stdlib/stats/base/dists/laplace/mgf/lib/main.js @@ -32,8 +32,8 @@ var pow = require( '@stdlib/math/base/special/pow' ); * Evaluates the moment-generating function (MGF) for a Laplace (double exponential) distribution with location parameter `mu` and scale parameter `b` at a value `t`. * * @param {number} t - input value -* @param {number} mu - mean -* @param {NonNegativeNumber} b - scale parameter +* @param {number} mu - location parameter +* @param {PositiveNumber} b - scale parameter * @returns {number} evaluated MGF * * @example diff --git a/lib/node_modules/@stdlib/stats/base/dists/laplace/mgf/lib/native.js b/lib/node_modules/@stdlib/stats/base/dists/laplace/mgf/lib/native.js index d533c2c7c176..f80ecf8d0f00 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/laplace/mgf/lib/native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/laplace/mgf/lib/native.js @@ -30,8 +30,8 @@ var addon = require( './../src/addon.node' ); * * @private * @param {number} t - input value -* @param {number} mu - mean -* @param {NonNegativeNumber} b - scale parameter +* @param {number} mu - location parameter +* @param {PositiveNumber} b - scale parameter * @returns {number} evaluated MGF * * @example