Skip to content

docs: propagate description and example fixes in stats/base/dists/* #12132

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 3 commits into from
May 14, 2026
Merged

docs: propagate description and example fixes in stats/base/dists/* #12132

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ae98d03
docs: collapse double spaces in `stats/base/dists/{gamma,pareto-type1…
claude May 14, 2026
1e2fb96
chore: propagate `stats/base/dists/normal/*` C example fix to `lognor…
claude May 14, 2026
7aab83d
docs: normalize description in `stats/base/dists/{discrete-uniform,pa…
claude May 14, 2026
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
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/stats/base/dists/discrete-uniform/logcdf/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ limitations under the License.

# Logarithm of Cumulative Distribution Function

> Evaluate the natural logarithm of the [cumulative distribution function][cdf] for a [discrete uniform][discrete-uniform-distribution] distribution.
> [Discrete uniform][discrete-uniform-distribution] distribution logarithm of [cumulative distribution function][cdf].

<section class="intro">

Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/stats/base/dists/discrete-uniform/logcdf/lib/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
'use strict';

/**
* Natural logarithm of the cumulative distribution function (CDF) for a discrete uniform distribution.
* Discrete uniform distribution logarithm of cumulative distribution function (CDF).
Copy link
Copy Markdown
Member

@kgryte kgryte May 14, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not wholly convinced that this is actually a better/preferred description practice. It reads more awkwardly than what we had before.

Copy link
Copy Markdown
Member

@kgryte kgryte May 14, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is based on "Discrete uniform distribution cumulative distribution function" which does read fine. Once you start throwing in other qualifiers, it starts straining the English language, making an awkward construction.

*
* @module @stdlib/stats/base/dists/discrete-uniform/logcdf
*
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/stats/base/dists/discrete-uniform/logcdf/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@stdlib/stats/base/dists/discrete-uniform/logcdf",
"version": "0.0.0",
"description": "Natural logarithm of the cumulative distribution function (CDF)for a discrete uniform distribution.",
"description": "Discrete uniform distribution logarithm of cumulative distribution function (CDF).",
"license": "Apache-2.0",
"author": {
"name": "The Stdlib Authors",
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/stats/base/dists/gamma/pdf/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@stdlib/stats/base/dists/gamma/pdf",
"version": "0.0.0",
"description": "Gamma distribution probability density function (PDF).",
"description": "Gamma distribution probability density function (PDF).",
"license": "Apache-2.0",
"author": {
"name": "The Stdlib Authors",
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/stats/base/dists/lognormal/entropy/examples/c/example.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ int main( void ) {

for ( i = 0; i < 10; i++ ) {
mu = random_uniform( -5.0, 5.0 );
sigma = random_uniform( 0.0, 20.0 );
sigma = random_uniform( 0.1, 20.0 );
y = stdlib_base_dists_lognormal_entropy( mu, sigma );
printf( "µ: %.4f, σ: %.4f, h(X;µ,σ): %.4f\n", mu, sigma, y );
}
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/stats/base/dists/lognormal/mean/examples/c/example.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ int main( void ) {

for ( i = 0; i < 10; i++ ) {
mu = random_uniform( -5.0, 5.0 );
sigma = random_uniform( 0.0, 20.0 );
sigma = random_uniform( 0.1, 20.0 );
y = stdlib_base_dists_lognormal_mean( mu, sigma );
printf( "µ: %.4f, σ: %.4f, E(X;µ,σ): %.4f\n", mu, sigma, y );
}
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/stats/base/dists/lognormal/median/examples/c/example.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ int main( void ) {

for ( i = 0; i < 10; i++ ) {
mu = random_uniform( -5.0, 5.0 );
sigma = random_uniform( 0.0, 20.0 );
sigma = random_uniform( 0.1, 20.0 );
y = stdlib_base_dists_lognormal_median( mu, sigma );
printf( "µ: %.4f, σ: %.4f, Median(X;µ,σ): %.4f\n", mu, sigma, y );
}
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/stats/base/dists/lognormal/mode/examples/c/example.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ int main( void ) {

for ( i = 0; i < 10; i++ ) {
mu = random_uniform( -5.0, 5.0 );
sigma = random_uniform( 0.0, 20.0 );
sigma = random_uniform( 0.1, 20.0 );
y = stdlib_base_dists_lognormal_mode( mu, sigma );
printf( "µ: %.4f, σ: %.4f, Mode(X;µ,σ): %.4f\n", mu, sigma, y );
}
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/stats/base/dists/lognormal/skewness/examples/c/example.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ int main( void ) {

for ( i = 0; i < 10; i++ ) {
mu = random_uniform( -5.0, 5.0 );
sigma = random_uniform( 0.0, 20.0 );
sigma = random_uniform( 0.1, 20.0 );
y = stdlib_base_dists_lognormal_skewness( mu, sigma );
printf("µ: %.4f, σ: %.4f, skew(X;µ,σ): %.4f\n", mu, sigma, y);
}
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/stats/base/dists/lognormal/stdev/examples/c/example.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ int main( void ) {

for ( i = 0; i < 10; i++ ) {
mu = random_uniform( -5.0, 5.0 );
sigma = random_uniform( 0.0, 20.0 );
sigma = random_uniform( 0.1, 20.0 );
y = stdlib_base_dists_lognormal_stdev( mu, sigma );
printf("µ: %.4f, σ: %.4f, SD(X; µ, σ): %.4f\n", mu, sigma, y);
}
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/stats/base/dists/lognormal/variance/examples/c/example.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ int main( void ) {

for ( i = 0; i < 25; i++ ) {
mu = random_uniform( -5.0, 5.0 );
sigma = random_uniform( 0.0, 20.0 );
sigma = random_uniform( 0.1, 20.0 );
y = stdlib_base_dists_lognormal_variance( mu, sigma );
printf( "µ: %lf, σ: %lf, Var(X;µ,σ): %lf\n", mu, sigma, y );
}
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/stats/base/dists/pareto-type1/logcdf/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ limitations under the License.

# Logarithm of Cumulative Distribution Function

> Evaluate the natural logarithm of the [cumulative distribution function][cdf] for a [Pareto (Type I)][pareto-distribution] distribution.
> [Pareto (Type I)][pareto-distribution] distribution logarithm of [cumulative distribution function][cdf].

<section class="intro">

Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/stats/base/dists/pareto-type1/logcdf/lib/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
'use strict';

/**
* Natural logarithm of the cumulative distribution function (CDF) for a Pareto (Type I) distribution.
* Pareto (Type I) distribution logarithm of cumulative distribution function (CDF).
*
* @module @stdlib/stats/base/dists/pareto-type1/logcdf
*
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/stats/base/dists/pareto-type1/logcdf/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@stdlib/stats/base/dists/pareto-type1/logcdf",
"version": "0.0.0",
"description": "Natural logarithm of the cumulative distribution function (CDF)for a Pareto (Type I) distribution.",
"description": "Pareto (Type I) distribution logarithm of cumulative distribution function (CDF).",
"license": "Apache-2.0",
"author": {
"name": "The Stdlib Authors",
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/stats/base/dists/pareto-type1/pdf/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@stdlib/stats/base/dists/pareto-type1/pdf",
"version": "0.0.0",
"description": "Pareto distribution (Type I) probability density function (PDF).",
"description": "Pareto distribution (Type I) probability density function (PDF).",
"license": "Apache-2.0",
"author": {
"name": "The Stdlib Authors",
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/stats/base/dists/rayleigh/cdf/examples/c/example.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ int main( void ) {

for ( i = 0; i < 25; i++ ) {
x = random_uniform( 0.0, 10.0 );
sigma = random_uniform( 0.0, 10.0 );
sigma = random_uniform( 0.1, 10.0 );
y = stdlib_base_dists_rayleigh_cdf( x, sigma );
printf( "x: %lf, σ: %lf, F(x;σ): %lf\n", x, sigma, y );
}
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/stats/base/dists/rayleigh/entropy/examples/c/example.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ int main( void ) {
int i;

for ( i = 0; i < 25; i++ ) {
sigma = random_uniform( 0.0, 20.0 );
sigma = random_uniform( 0.1, 20.0 );
y = stdlib_base_dists_rayleigh_entropy( sigma );
printf( "σ: %lf, h(σ): %lf\n", sigma, y );
}
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/stats/base/dists/rayleigh/kurtosis/examples/c/example.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ int main( void ) {
int i;

for ( i = 0; i < 25; i++ ) {
sigma = random_uniform( 0.0, 10.0 );
sigma = random_uniform( 0.1, 10.0 );
y = stdlib_base_dists_rayleigh_kurtosis( sigma );
printf( "σ: %lf, Kurt(X,σ): %lf\n", sigma, y );
}
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/stats/base/dists/rayleigh/logcdf/examples/c/example.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ int main( void ) {

for ( i = 0; i < 25; i++ ) {
x = random_uniform( 0.0, 10.0 );
sigma = random_uniform( 0.0, 10.0 );
sigma = random_uniform( 0.1, 10.0 );
y = stdlib_base_dists_rayleigh_logcdf( x, sigma );
printf( "x: %lf, σ: %lf, F(x;σ): %lf\n", x, sigma, y );
}
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/stats/base/dists/rayleigh/logpdf/examples/c/example.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ int main( void ) {

for ( i = 0; i < 25; i++ ) {
x = random_uniform( 0.0, 10.0 );
sigma = random_uniform( 0.0, 10.0 );
sigma = random_uniform( 0.1, 10.0 );
y = stdlib_base_dists_rayleigh_logpdf( x, sigma );
printf( "x: %lf, σ: %lf, ln(f(x;σ)): %lf\n", x, sigma, y );
}
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/stats/base/dists/rayleigh/mean/examples/c/example.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ int main( void ) {
int i;

for ( i = 0; i < 25; i++ ) {
sigma = random_uniform( 0.0, 20.0 );
sigma = random_uniform( 0.1, 20.0 );
y = stdlib_base_dists_rayleigh_mean( sigma );
printf( "σ: %lf, E(X;σ): %lf\n", sigma, y );
}
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/stats/base/dists/rayleigh/median/examples/c/example.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ int main( void ) {
int i;

for ( i = 0; i < 25; i++ ) {
sigma = random_uniform( 0.0, 20.0 );
sigma = random_uniform( 0.1, 20.0 );
y = stdlib_base_dists_rayleigh_median( sigma );
printf( "σ: %lf, Median(X;σ): %lf\n", sigma, y );
}
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/stats/base/dists/rayleigh/mode/examples/c/example.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ int main( void ) {
int i;

for ( i = 0; i < 25; i++ ) {
sigma = random_uniform( 0.0, 20.0 );
sigma = random_uniform( 0.1, 20.0 );
y = stdlib_base_dists_rayleigh_mode( sigma );
printf( "σ: %lf, mode(X;σ): %lf\n", sigma, y );
}
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/stats/base/dists/rayleigh/pdf/examples/c/example.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ int main( void ) {

for ( i = 0; i < 25; i++ ) {
x = random_uniform( 0.0, 10.0 );
sigma = random_uniform( 0.0, 10.0 );
sigma = random_uniform( 0.1, 10.0 );
y = stdlib_base_dists_rayleigh_pdf( x, sigma );
printf( "x: %lf, σ: %lf, f(x;σ): %lf\n", x, sigma, y );
}
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/stats/base/dists/rayleigh/variance/examples/c/example.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ int main( void ) {
int i;

for ( i = 0; i < 25; i++ ) {
sigma = random_uniform( 0.0, 20.0 );
sigma = random_uniform( 0.1, 20.0 );
y = stdlib_base_dists_rayleigh_variance( sigma );
printf( "σ: %lf, Var(X;σ): %lf\n", sigma, y );
}
Expand Down