From 30d9788e9ed67a8a6fc403b344966e0ea76074c1 Mon Sep 17 00:00:00 2001 From: Claude Date: Tue, 12 May 2026 04:21:33 +0000 Subject: [PATCH] docs: correct `s` predicate in d.ts Notes for `stats/base/dists/cosine/mgf` The TypeScript declaration Notes section claimed the function returns `NaN` when `s < 0`, but the implementation (`lib/main.js`, `lib/factory.js`, `src/main.c`) rejects `s <= 0.0`, the JSDoc declares `s` as a `PositiveNumber`, and both the README and `docs/repl.txt` already document `s <= 0`. The declaration was the only artifact in the package that disagreed with the actual validation predicate; update its Notes section to match. In the wider `stats/base/dists/cosine` namespace, 13 of 14 packages already have d.ts Notes that match their source validation (7 scalar moments use `s <= 0`; 4 strictly-evaluated functions use `s < 0`; quantile mentions both `s` and `p` bounds). `mgf` was the lone holdout. --- .../@stdlib/stats/base/dists/cosine/mgf/docs/types/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/cosine/mgf/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/dists/cosine/mgf/docs/types/index.d.ts index 77f95af02d5b..1d3a512e2339 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cosine/mgf/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/mgf/docs/types/index.d.ts @@ -35,7 +35,7 @@ interface MGF { * * ## Notes * - * - If provided `s < 0`, the function returns `NaN`. + * - If provided `s <= 0`, the function returns `NaN`. * * @param t - input value * @param mu - location parameter