Skip to content

docs: update descriptions #13370

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 7 commits into from
Jul 8, 2026
Merged

docs: update descriptions #13370

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
bb83395
docs: fix incorrect function description in `stats/base/dists/pareto-…
claude Jul 8, 2026
d1c243c
docs: normalize brief phrasings in `stats/base/dists/pareto-type1/log…
claude Jul 8, 2026
af82768
docs: normalize module brief in `stats/base/dists/pareto-type1/pdf`
claude Jul 8, 2026
c37f188
Apply suggestions from code review
kgryte Jul 8, 2026
f7f495a
Discard changes to lib/node_modules/@stdlib/stats/base/dists/pareto-t…
kgryte Jul 8, 2026
6b02b25
Discard changes to lib/node_modules/@stdlib/stats/base/dists/pareto-t…
kgryte Jul 8, 2026
642026f
Discard changes to lib/node_modules/@stdlib/stats/base/dists/pareto-t…
kgryte Jul 8, 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 ...tats/base/dists/pareto-type1/logcdf/include/stdlib/stats/base/dists/pareto-type1/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 cumulative distribution function (CDF) for a Pareto (Type I) distribution with shape parameter `alpha` and scale parameter `beta` at a value `x`.
* Evaluates the natural logarithm of the cumulative distribution function (CDF) for a Pareto (Type I) distribution with shape parameter `alpha` and scale parameter `beta` at a value `x`.
*/
double stdlib_base_dists_pareto_type1_logcdf( const double x, const double alpha, const double beta );

Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/stats/base/dists/pareto-type1/logcdf/lib/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ var NINF = require( '@stdlib/constants/float64/ninf' );
// MAIN //

/**
* Evaluates the cumulative distribution function (CDF) for a Pareto (Type I) distribution with shape parameter `alpha` and scale parameter `beta` at a value `x`.
* Evaluates the natural logarithm of the cumulative distribution function (CDF) for a Pareto (Type I) distribution with shape parameter `alpha` and scale parameter `beta` at a value `x`.
*
* @param {number} x - input value
* @param {PositiveNumber} alpha - shape parameter
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/stats/base/dists/pareto-type1/logcdf/lib/native.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ var addon = require( './../src/addon.node' );
// MAIN //

/**
* Evaluates the cumulative distribution function (CDF) for a Pareto (Type I) distribution with shape parameter `alpha` and scale parameter `beta` at a value `x`.
* Evaluates the natural logarithm of the cumulative distribution function (CDF) for a Pareto (Type I) distribution with shape parameter `alpha` and scale parameter `beta` at a value `x`.
*
* @private
* @param {number} x - input value
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/stats/base/dists/pareto-type1/logcdf/src/main.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
#include "stdlib/math/base/special/pow.h"

/**
* Evaluates the cumulative distribution function (CDF) for a Pareto (Type I) distribution with shape parameter `alpha` and scale parameter `beta` at a value `x`.
* Evaluates the natural logarithm of the cumulative distribution function (CDF) for a Pareto (Type I) distribution with shape parameter `alpha` and scale parameter `beta` at a value `x`.
*
* @param x input value
* @param alpha shape parameter
Expand Down