From 5807ad6c767d35a8a79714afa30027c78c819888 Mon Sep 17 00:00:00 2001 From: Claude Date: Mon, 12 Oct 2026 12:39:36 +0000 Subject: [PATCH] docs: fix parameter descriptions in `stats/base/dists/lognormal/logcdf` C API Replaced "mean"/"standard deviation" with "location parameter"/"scale parameter" in the C API docs of the README, `src/main.c`, and the `logcdf.h` header. This matches the package's own JavaScript docs and 12 of the 13 native packages in the namespace (92%). Co-Authored-By: Claude Opus 5.5 Claude-Session: https://claude.ai/code/session_01HSkiPsMzywnDwgruQgSSw6 --- .../@stdlib/stats/base/dists/lognormal/logcdf/README.md | 6 +++--- .../include/stdlib/stats/base/dists/lognormal/logcdf.h | 2 +- .../@stdlib/stats/base/dists/lognormal/logcdf/src/main.c | 6 +++--- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/dists/lognormal/logcdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/lognormal/logcdf/README.md index b0cebe481a72..fda16db0be62 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/lognormal/logcdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/lognormal/logcdf/README.md @@ -152,7 +152,7 @@ logEachMap( 'x: %0.4f, μ: %0.4f, σ: %0.4f, ln(F(x;μ,σ)): %0.4f', x, mu, sigm #### stdlib_base_dists_lognormal_logcdf( x, mu, sigma ) -Evaluates the natural logarithm of the [cumulative distribution function][cdf] (CDF) for a [lognormal][lognormal-distribution] distribution with mean `mu` and standard deviation `sigma` at a value `x`. +Evaluates the natural logarithm of the [cumulative distribution function][cdf] (CDF) for a [lognormal][lognormal-distribution] distribution with location parameter `mu` and scale parameter `sigma` at a value `x`. ```c double y = stdlib_base_dists_lognormal_logcdf( 2.0, 0.0, 1.0 ); @@ -162,8 +162,8 @@ double y = stdlib_base_dists_lognormal_logcdf( 2.0, 0.0, 1.0 ); The function accepts the following arguments: - **x**: `[in] double` input value. -- **mu**: `[in] double` mean. -- **sigma**: `[in] double` standard deviation. +- **mu**: `[in] double` location parameter. +- **sigma**: `[in] double` scale parameter. ```c double stdlib_base_dists_lognormal_logcdf( const double x, const double mu, const double sigma ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/lognormal/logcdf/include/stdlib/stats/base/dists/lognormal/logcdf.h b/lib/node_modules/@stdlib/stats/base/dists/lognormal/logcdf/include/stdlib/stats/base/dists/lognormal/logcdf.h index cc1b5358aaf0..89b34f7fbdb7 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/lognormal/logcdf/include/stdlib/stats/base/dists/lognormal/logcdf.h +++ b/lib/node_modules/@stdlib/stats/base/dists/lognormal/logcdf/include/stdlib/stats/base/dists/lognormal/logcdf.h @@ -27,7 +27,7 @@ extern "C" { #endif /** -* Evaluates the natural logarithm of the cumulative distribution function (CDF) for a lognormal distribution with mean `mu` and standard deviation `sigma` at a value `x`. +* Evaluates the natural logarithm of the cumulative distribution function (CDF) for a lognormal distribution with location parameter `mu` and scale parameter `sigma` at a value `x`. */ double stdlib_base_dists_lognormal_logcdf( const double x, const double mu, const double sigma ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/lognormal/logcdf/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/lognormal/logcdf/src/main.c index bcfa408892fc..c9bed411c159 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/lognormal/logcdf/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/lognormal/logcdf/src/main.c @@ -28,11 +28,11 @@ static const double INV_SQRT_TWO = 0.7071067811865475; // 1/sqrt(2) /** -* Evaluates the natural logarithm of the cumulative distribution function (CDF) for a lognormal distribution with mean `mu` and standard deviation `sigma` at a value `x`. +* Evaluates the natural logarithm of the cumulative distribution function (CDF) for a lognormal distribution with location parameter `mu` and scale parameter `sigma` at a value `x`. * * @param x input value -* @param mu mean -* @param sigma standard deviation +* @param mu location parameter +* @param sigma scale parameter * @return evaluated logCDF * * @example