Skip to content

docs: update parameter type and add keyword #12729

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 2 commits into from
Jun 10, 2026
Merged

docs: update parameter type and add keyword #12729

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4415b33
docs: align `stats/strided/distances/dcorrelation` JSDoc, README, and…
claude Jun 9, 2026
a000843
docs: revert README C API heading change in `stats/strided/distances/…
claude Jun 9, 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/strided/distances/dcorrelation/lib/dcorrelation.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ var ndarray = require( './ndarray.js' );
/**
* Computes the correlation distance between two double-precision floating-point strided arrays.
*
* @param {PositiveInteger} N - number of indexed elements
* @param {NonNegativeInteger} N - number of indexed elements
* @param {Float64Array} x - first input array
* @param {integer} strideX - stride length of `x`
* @param {Float64Array} y - second input array
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/stats/strided/distances/dcorrelation/lib/dcorrelation.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' );
/**
* Computes the correlation distance between two double-precision floating-point strided arrays.
*
* @param {PositiveInteger} N - number of indexed elements
* @param {NonNegativeInteger} N - number of indexed elements
* @param {Float64Array} x - first input array
* @param {integer} strideX - stride length of `x`
* @param {Float64Array} y - second input array
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/stats/strided/distances/dcorrelation/lib/ndarray.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ var dpcorr = require( '@stdlib/stats/strided/dpcorr' ).ndarray;
/**
* Computes the correlation distance between two double-precision floating-point strided arrays using alternative indexing semantics.
*
* @param {PositiveInteger} N - number of indexed elements
* @param {NonNegativeInteger} N - number of indexed elements
* @param {Float64Array} x - first input array
* @param {integer} strideX - stride length of `x`
* @param {NonNegativeInteger} offsetX - starting index of `x`
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/stats/strided/distances/dcorrelation/lib/ndarray.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' );
/**
* Computes the correlation distance between two double-precision floating-point strided arrays using alternative indexing semantics.
*
* @param {PositiveInteger} N - number of indexed elements
* @param {NonNegativeInteger} N - number of indexed elements
* @param {Float64Array} x - first input array
* @param {integer} strideX - stride length of `x`
* @param {NonNegativeInteger} offsetX - starting index of `x`
Expand Down
1 change: 1 addition & 0 deletions lib/node_modules/@stdlib/stats/strided/distances/dcorrelation/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@
"dcorrelation",
"correlation",
"distance",
"metric",
"strided",
"strided array",
"typed",
Expand Down