From 8868c50bbcad9cd3305518c45dcb87988765e85d Mon Sep 17 00:00:00 2001 From: Claude Date: Tue, 26 May 2026 12:26:53 +0000 Subject: [PATCH 1/2] docs: normalize example variable naming in `@stdlib/stats/base/dists/chisquare/median` Replaced `var y` and `var k` with `var v` in the negative-input and NaN `@example` blocks so the package matches the convention used by all seven single-argument sibling distribution packages (`entropy`, `kurtosis`, `mean`, `mode`, `skewness`, `stdev`, `variance`), where `var v = ( ... );` appears uniformly across all four examples in both the README and the TypeScript declaration file (87.5% conformance). The package's own `lib/main.js` already uses `var v` throughout, so the divergence was confined to `README.md` and `docs/types/index.d.ts`. --- .../@stdlib/stats/base/dists/chisquare/median/README.md | 2 +- .../stats/base/dists/chisquare/median/docs/types/index.d.ts | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/chisquare/median/README.md b/lib/node_modules/@stdlib/stats/base/dists/chisquare/median/README.md index 90e771a2dae7..c9fbe26afeba 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/chisquare/median/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/chisquare/median/README.md @@ -55,7 +55,7 @@ v = median( 2.0 ); If provided `k < 0`, the function returns `NaN`. ```javascript -var y = median( -1.0 ); +var v = median( -1.0 ); // returns NaN ``` diff --git a/lib/node_modules/@stdlib/stats/base/dists/chisquare/median/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/dists/chisquare/median/docs/types/index.d.ts index cd0963ab3a4b..2f096bf611f0 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/chisquare/median/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/dists/chisquare/median/docs/types/index.d.ts @@ -37,11 +37,11 @@ * // returns ~1.386 * * @example -* var k = median( -0.2 ); +* var v = median( -0.2 ); * // returns NaN * * @example -* var k = median( NaN ); +* var v = median( NaN ); * // returns NaN */ declare function median( k: number ): number; From 460014c9449d8a3406eab6ff3f558f6de2640771 Mon Sep 17 00:00:00 2001 From: Claude Date: Tue, 26 May 2026 12:27:00 +0000 Subject: [PATCH 2/2] docs: add domain constraint to `@stdlib/stats/base/dists/chisquare/mean` intro MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The intro section previously read "where \`k\` is the degrees of freedom"; updated to "where \`k >= 0\` is the degrees of freedom" to match the convention used by the three other `NonNegativeNumber`-domain siblings in this namespace (`mode`, `stdev`, `variance` — 3/4 = 75% conformance). The constraint matches the existing Notes statement "If provided \`k < 0\`, the function returns \`NaN\`" found later in the same file. --- .../@stdlib/stats/base/dists/chisquare/mean/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/chisquare/mean/README.md b/lib/node_modules/@stdlib/stats/base/dists/chisquare/mean/README.md index 611f3667ec0c..59b44ee9351f 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/chisquare/mean/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/chisquare/mean/README.md @@ -41,7 +41,7 @@ The [expected value][expected-value] for a [chi-squared][chisquare-distribution] -where `k` is the degrees of freedom. +where `k >= 0` is the degrees of freedom.