From a3f6813f9285949e301820c9ede7222e4f1409a4 Mon Sep 17 00:00:00 2001 From: Claude Date: Thu, 20 Aug 2026 20:23:10 +0000 Subject: [PATCH] docs: fix JSDoc drift in `stats/base/dists/logistic/logcdf` Corrects two JSDoc-only inconsistencies in `stats/base/dists/logistic/logcdf` identified by a majority-vote sweep against the 14 sibling packages in the `stats/base/dists/logistic` namespace: - `lib/index.js`: drop the redundant second `var y` in the `@module` `@example` block. `y` is already declared four lines above, and all five sibling factory-bearing packages (`cdf`, `pdf`, `logpdf`, `mgf`, `quantile`) reuse the identifier on the second call (5/5 conformance among factory-bearing siblings). - `docs/types/index.d.ts`: change the `Unary` type's `@returns evaluated logarithm of CDF` to `@returns evaluated logCDF`, matching the wording already used at lines 43 and 92 of the same file and the `evaluated ` convention used by every sibling type-def (5/5 sibling type-defs). No runtime, signature, or test-expected behavior changes. --- .../stats/base/dists/logistic/logcdf/docs/types/index.d.ts | 2 +- .../@stdlib/stats/base/dists/logistic/logcdf/lib/index.js | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/logistic/logcdf/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/dists/logistic/logcdf/docs/types/index.d.ts index 9d25655ae7c4..bf37ffeacc39 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/logistic/logcdf/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/dists/logistic/logcdf/docs/types/index.d.ts @@ -22,7 +22,7 @@ * Evaluates the natural logarithm of the cumulative distribution function (CDF) for a logistic distribution. * * @param x - input value -* @returns evaluated logarithm of CDF +* @returns evaluated logCDF */ type Unary = ( x: number ) => number; diff --git a/lib/node_modules/@stdlib/stats/base/dists/logistic/logcdf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/logistic/logcdf/lib/index.js index 6e4766da9670..2d0255dd39a8 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/logistic/logcdf/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/logistic/logcdf/lib/index.js @@ -31,7 +31,7 @@ * * var mylogcdf = logcdf.factory( 3.0, 1.5 ); * -* var y = mylogcdf( 1.0 ); +* y = mylogcdf( 1.0 ); * // returns ~-1.567 */