From 0ae86dd2067291caa30e7858c03953df5d25e25b Mon Sep 17 00:00:00 2001 From: Claude Date: Sat, 6 Jun 2026 08:16:25 +0000 Subject: [PATCH] docs: fix JSDoc descriptions in `@stdlib/stats/base/dists/cauchy/logcdf` Correct three JSDoc copy-paste/spacing errors surfaced by within-namespace majority vote across `stats/base/dists/cauchy` (9 members): - `lib/index.js` module description was a copy of the `cdf` package's description; updated to match the package's own `package.json` description (8/9 = 88.9% of cauchy siblings have matching `index.js`/`package.json` descriptions). - `lib/native.js` function description dropped the word `natural` from `natural logarithm`; restored to match `lib/main.js` (7/8 = 87.5% of cauchy siblings with `native.js` have identical descriptions in `main.js` and `native.js`). - `lib/factory.js` line 63 had a double space in the inner-function description; collapsed to single space (4/5 = 80% of cauchy `factory.js` inner-function descriptions use single spacing). Documentation only; no source, test, or behavioral changes. --- .../@stdlib/stats/base/dists/cauchy/logcdf/lib/factory.js | 2 +- .../@stdlib/stats/base/dists/cauchy/logcdf/lib/index.js | 2 +- .../@stdlib/stats/base/dists/cauchy/logcdf/lib/native.js | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/cauchy/logcdf/lib/factory.js b/lib/node_modules/@stdlib/stats/base/dists/cauchy/logcdf/lib/factory.js index d2ef5e1865e0..d67c1a72767b 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cauchy/logcdf/lib/factory.js +++ b/lib/node_modules/@stdlib/stats/base/dists/cauchy/logcdf/lib/factory.js @@ -60,7 +60,7 @@ function factory( x0, gamma ) { return logcdf; /** - * Evaluates the natural logarithm of the cumulative distribution function (logCDF) for a Cauchy distribution. + * Evaluates the natural logarithm of the cumulative distribution function (logCDF) for a Cauchy distribution. * * @private * @param {number} x - input value diff --git a/lib/node_modules/@stdlib/stats/base/dists/cauchy/logcdf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/cauchy/logcdf/lib/index.js index 4b55bcda74d5..5901e64669a6 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cauchy/logcdf/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/cauchy/logcdf/lib/index.js @@ -19,7 +19,7 @@ 'use strict'; /** -* Cauchy distribution cumulative distribution function (CDF). +* Cauchy distribution natural logarithm of cumulative distribution function (CDF). * * @module @stdlib/stats/base/dists/cauchy/logcdf * diff --git a/lib/node_modules/@stdlib/stats/base/dists/cauchy/logcdf/lib/native.js b/lib/node_modules/@stdlib/stats/base/dists/cauchy/logcdf/lib/native.js index 2aafa9085d6c..448be04440c2 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cauchy/logcdf/lib/native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/cauchy/logcdf/lib/native.js @@ -26,7 +26,7 @@ var addon = require( './../src/addon.node' ); // MAIN // /** -* Evaluates the logarithm of the cumulative distribution function (logCDF) for a Cauchy distribution with location parameter `x0` and scale parameter `gamma` at a value `x`. +* Evaluates the natural logarithm of the cumulative distribution function (logCDF) for a Cauchy distribution with location parameter `x0` and scale parameter `gamma` at a value `x`. * * @private * @param {number} x - input value