From ea98bfd74ad37533e809c93ac8f8f7c1f577f986 Mon Sep 17 00:00:00 2001 From: Claude Date: Wed, 7 Oct 2026 04:42:00 +0000 Subject: [PATCH 1/2] docs: add JSDoc examples to `math/base/special/gammaincinv` Added missing `@example` tags to the primary JSDoc in `lib/main.js` (present in 382 of 383 packages in `math/base/special`, 99.7%). Examples mirror those already documented in `lib/index.js`. Co-Authored-By: Claude Opus 5.5 Claude-Session: https://claude.ai/code/session_01LDgawJ2nLhuTjXQGz1yUku --- .../math/base/special/gammaincinv/lib/main.js | 24 +++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/lib/node_modules/@stdlib/math/base/special/gammaincinv/lib/main.js b/lib/node_modules/@stdlib/math/base/special/gammaincinv/lib/main.js index be35fea57f4a..5ecab7bff679 100644 --- a/lib/node_modules/@stdlib/math/base/special/gammaincinv/lib/main.js +++ b/lib/node_modules/@stdlib/math/base/special/gammaincinv/lib/main.js @@ -61,6 +61,30 @@ var compute = require( './compute.js' ); * @param {number} a - scale parameter * @param {boolean} [upper=false] - boolean indicating if the function should invert the upper tail of the incomplete gamma function instead; i.e., compute `xr` such that `Q(a,xr) = p`. * @returns {number} function value of the inverse +* +* @example +* var y = gammaincinv( 0.5, 2.0 ); +* // returns ~1.678 +* +* @example +* var y = gammaincinv( 0.1, 10.0 ); +* // returns ~6.221 +* +* @example +* var y = gammaincinv( 0.75, 3.0 ); +* // returns ~3.92 +* +* @example +* var y = gammaincinv( 0.75, 3.0, true ); +* // returns ~1.727 +* +* @example +* var y = gammaincinv( 0.75, NaN ); +* // returns NaN +* +* @example +* var y = gammaincinv( NaN, 3.0 ); +* // returns NaN */ function gammaincinv( p, a, upper ) { if ( isnan( p ) || isnan( a ) ) { From 8c60cbd420cf901fbafd936a246a6453eca51c58 Mon Sep 17 00:00:00 2001 From: Athan Date: Mon, 12 Oct 2026 14:51:10 +0200 Subject: [PATCH 2/2] docs: update description Signed-off-by: Athan --- .../@stdlib/math/base/special/gammaincinv/lib/main.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/math/base/special/gammaincinv/lib/main.js b/lib/node_modules/@stdlib/math/base/special/gammaincinv/lib/main.js index 5ecab7bff679..73011deb4d0b 100644 --- a/lib/node_modules/@stdlib/math/base/special/gammaincinv/lib/main.js +++ b/lib/node_modules/@stdlib/math/base/special/gammaincinv/lib/main.js @@ -59,7 +59,7 @@ var compute = require( './compute.js' ); * * @param {Probability} p - probability value * @param {number} a - scale parameter -* @param {boolean} [upper=false] - boolean indicating if the function should invert the upper tail of the incomplete gamma function instead; i.e., compute `xr` such that `Q(a,xr) = p`. +* @param {boolean} [upper=false] - boolean indicating if the function should invert the upper tail of the incomplete gamma function instead (i.e., compute `xr` such that `Q(a,xr) = p`) * @returns {number} function value of the inverse * * @example