Skip to content

docs: fix descriptions #15863

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 5 commits into from
Oct 12, 2026
Merged

docs: fix descriptions #15863

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
13b5d46
docs: fix descriptions and return value annotations in `stats/base/nd…
0PrashantYadav0 Oct 3, 2026
b6819c6
Discard changes to lib/node_modules/@stdlib/stats/base/ndarray/smeank…
kgryte Oct 12, 2026
ecc558a
Discard changes to lib/node_modules/@stdlib/stats/base/ndarray/smeank…
kgryte Oct 12, 2026
077fce9
Discard changes to lib/node_modules/@stdlib/stats/base/ndarray/smeank…
kgryte Oct 12, 2026
2d3ba1e
Discard changes to lib/node_modules/@stdlib/stats/base/ndarray/smeank…
kgryte Oct 12, 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/ndarray/dvariancewd/lib/native.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ var addon = require( './../src/addon.node' );
// MAIN //

/**
* Computes the variance of a one-dimensional double-precision floating-point ndarray using a Welford's algorithm.
* Computes the variance of a one-dimensional double-precision floating-point ndarray using Welford's algorithm.
*
* ## Notes
*
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/stats/base/ndarray/smaxabs/lib/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ var strided = require( '@stdlib/stats/strided/smaxabs' ).ndarray;
* - a one-dimensional input ndarray.
*
* @param {ArrayLikeObject<Object>} arrays - array-like object containing ndarrays
* @returns {number} maximum value
* @returns {number} maximum absolute value
*
* @example
* var Float32Vector = require( '@stdlib/ndarray/vector/float32' );
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/stats/base/ndarray/smaxabssorted/lib/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ var strided = require( '@stdlib/stats/strided/smaxabssorted' ).ndarray;
* - a one-dimensional input ndarray.
*
* @param {ArrayLikeObject<Object>} arrays - array-like object containing ndarrays
* @returns {number} maximum value
* @returns {number} maximum absolute value
*
* @example
* var Float32Vector = require( '@stdlib/ndarray/vector/float32' );
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/stats/base/ndarray/smeanlipw/lib/native.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ var addon = require( './../src/addon.node' );
// MAIN //

/**
* Computes the arithmetic mean of a one-dimensional single-precision floating-point ndarray.
* Computes the arithmetic mean of a one-dimensional single-precision floating-point ndarray using a one-pass trial mean algorithm with pairwise summation.
*
* ## Notes
*
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/stats/base/ndarray/sminabs/lib/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ var strided = require( '@stdlib/stats/strided/sminabs' ).ndarray;
* - a one-dimensional input ndarray.
*
* @param {ArrayLikeObject<Object>} arrays - array-like object containing ndarrays
* @returns {number} minimum value
* @returns {number} minimum absolute value
*
* @example
* var Float32Vector = require( '@stdlib/ndarray/vector/float32' );
Expand Down
Loading