Skip to content

docs: fix parameter descriptions #16083

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kgryte merged 1 commit into from
Oct 12, 2026
Merged

docs: fix parameter descriptions #16083

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions lib/node_modules/@stdlib/stats/base/dists/lognormal/logcdf/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 );
Expand All @@ -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 );
Expand Down
2 changes: 1 addition & 1 deletion ...dlib/stats/base/dists/lognormal/logcdf/include/stdlib/stats/base/dists/lognormal/logcdf.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 );

Expand Down
6 changes: 3 additions & 3 deletions lib/node_modules/@stdlib/stats/base/dists/lognormal/logcdf/src/main.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading