docs: update namespace TypeScript declarations

stdlib-bot · web-flow · commit 1d7a2dfcb1cb · 2025-01-09T02:14:41.000-08:00
PR-URL: #4656 Reviewed-by: Athan Reines <kgryte@gmail.com>
diff --git a/lib/node_modules/@stdlib/blas/ext/base/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/docs/types/index.d.ts
@@ -1396,7 +1396,7 @@ interface Namespace {
 	*
 	* @param N - number of indexed elements
 	* @param x - input array
-	* @param stride - stride length
+	* @param strideX - stride length
 	* @returns sum
 	*
 	* @example
@@ -1422,7 +1422,7 @@ interface Namespace {
 	*
 	* @param N - number of indexed elements
 	* @param x - input array
-	* @param stride - stride length
+	* @param strideX - stride length
 	* @returns sum
 	*
 	* @example
@@ -1835,7 +1835,7 @@ interface Namespace {
 	*
 	* @param N - number of indexed elements
 	* @param x - input array
-	* @param stride - stride length
+	* @param strideX - stride length
 	* @returns sum
 	*
 	* @example
@@ -1857,7 +1857,7 @@ interface Namespace {
 	*
 	* @param N - number of indexed elements
 	* @param x - input array
-	* @param stride - stride length
+	* @param strideX - stride length
 	* @returns sum
 	*
 	* @example
@@ -1879,7 +1879,7 @@ interface Namespace {
 	*
 	* @param N - number of indexed elements
 	* @param x - input array
-	* @param stride - stride length
+	* @param strideX - stride length
 	* @returns sum
 	*
 	* @example
@@ -1901,7 +1901,7 @@ interface Namespace {
 	*
 	* @param N - number of indexed elements
 	* @param x - input array
-	* @param stride - stride length
+	* @param strideX - stride length
 	* @returns sum
 	*
 	* @example
@@ -1923,7 +1923,7 @@ interface Namespace {
 	*
 	* @param N - number of indexed elements
 	* @param x - input array
-	* @param stride - stride length
+	* @param strideX - stride length
 	* @returns sum
 	*
 	* @example
diff --git a/lib/node_modules/@stdlib/stats/base/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/docs/types/index.d.ts
@@ -913,7 +913,7 @@ interface Namespace {
 	*
 	* @param N - number of indexed elements
 	* @param x - input array
-	* @param stride - stride length
+	* @param strideX - stride length
 	* @returns arithmetic mean
 	*
 	* @example
@@ -2295,7 +2295,7 @@ interface Namespace {
 	* @param N - number of indexed elements
 	* @param correction - degrees of freedom adjustment
 	* @param x - input array
-	* @param stride - stride length
+	* @param strideX - stride length
 	* @returns standard deviation
 	*
 	* @example
@@ -2349,7 +2349,7 @@ interface Namespace {
 	* @param N - number of indexed elements
 	* @param correction - degrees of freedom adjustment
 	* @param x - input array
-	* @param stride - stride length
+	* @param strideX - stride length
 	* @returns standard deviation
 	*
 	* @example
@@ -2376,7 +2376,7 @@ interface Namespace {
 	* @param N - number of indexed elements
 	* @param correction - degrees of freedom adjustment
 	* @param x - input array
-	* @param stride - stride length
+	* @param strideX - stride length
 	* @returns standard deviation
 	*
 	* @example
@@ -2403,23 +2403,23 @@ interface Namespace {
 	* @param N - number of indexed elements
 	* @param correction - degrees of freedom adjustment
 	* @param x - input array
-	* @param stride - stride length
+	* @param strideX - stride length
 	* @returns standard deviation
 	*
 	* @example
 	* var Float64Array = require( '@stdlib/array/float64' );
 	*
 	* var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );
 	*
-	* var v = ns.dstdevyc( x.length, 1, x, 1 );
+	* var v = ns.dstdevyc( x.length, 1.0, x, 1 );
 	* // returns ~2.0817
 	*
 	* @example
 	* var Float64Array = require( '@stdlib/array/float64' );
 	*
 	* var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );
 	*
-	* var v = ns.dstdevyc.ndarray( x.length, 1, x, 1, 0 );
+	* var v = ns.dstdevyc.ndarray( x.length, 1.0, x, 1, 0 );
 	* // returns ~2.0817
 	*/
 	dstdevyc: typeof dstdevyc;

Original file line number	Diff line number	Diff line change
`@@ -1396,7 +1396,7 @@ interface Namespace {`
`1396`	`1396`	`*`
`1397`	`1397`	`* @param N - number of indexed elements`
`1398`	`1398`	`* @param x - input array`
`1399`		`- * @param stride - stride length`
	`1399`	`+ * @param strideX - stride length`
`1400`	`1400`	`* @returns sum`
`1401`	`1401`	`*`
`1402`	`1402`	`* @example`
`@@ -1422,7 +1422,7 @@ interface Namespace {`
`1422`	`1422`	`*`
`1423`	`1423`	`* @param N - number of indexed elements`
`1424`	`1424`	`* @param x - input array`
`1425`		`- * @param stride - stride length`
	`1425`	`+ * @param strideX - stride length`
`1426`	`1426`	`* @returns sum`
`1427`	`1427`	`*`
`1428`	`1428`	`* @example`
`@@ -1835,7 +1835,7 @@ interface Namespace {`
`1835`	`1835`	`*`
`1836`	`1836`	`* @param N - number of indexed elements`
`1837`	`1837`	`* @param x - input array`
`1838`		`- * @param stride - stride length`
	`1838`	`+ * @param strideX - stride length`
`1839`	`1839`	`* @returns sum`
`1840`	`1840`	`*`
`1841`	`1841`	`* @example`
`@@ -1857,7 +1857,7 @@ interface Namespace {`
`1857`	`1857`	`*`
`1858`	`1858`	`* @param N - number of indexed elements`
`1859`	`1859`	`* @param x - input array`
`1860`		`- * @param stride - stride length`
	`1860`	`+ * @param strideX - stride length`
`1861`	`1861`	`* @returns sum`
`1862`	`1862`	`*`
`1863`	`1863`	`* @example`
`@@ -1879,7 +1879,7 @@ interface Namespace {`
`1879`	`1879`	`*`
`1880`	`1880`	`* @param N - number of indexed elements`
`1881`	`1881`	`* @param x - input array`
`1882`		`- * @param stride - stride length`
	`1882`	`+ * @param strideX - stride length`
`1883`	`1883`	`* @returns sum`
`1884`	`1884`	`*`
`1885`	`1885`	`* @example`
`@@ -1901,7 +1901,7 @@ interface Namespace {`
`1901`	`1901`	`*`
`1902`	`1902`	`* @param N - number of indexed elements`
`1903`	`1903`	`* @param x - input array`
`1904`		`- * @param stride - stride length`
	`1904`	`+ * @param strideX - stride length`
`1905`	`1905`	`* @returns sum`
`1906`	`1906`	`*`
`1907`	`1907`	`* @example`
`@@ -1923,7 +1923,7 @@ interface Namespace {`
`1923`	`1923`	`*`
`1924`	`1924`	`* @param N - number of indexed elements`
`1925`	`1925`	`* @param x - input array`
`1926`		`- * @param stride - stride length`
	`1926`	`+ * @param strideX - stride length`
`1927`	`1927`	`* @returns sum`
`1928`	`1928`	`*`
`1929`	`1929`	`* @example`
Original file line number	Diff line number	Diff line change
`@@ -913,7 +913,7 @@ interface Namespace {`
`913`	`913`	`*`
`914`	`914`	`* @param N - number of indexed elements`
`915`	`915`	`* @param x - input array`
`916`		`- * @param stride - stride length`
	`916`	`+ * @param strideX - stride length`
`917`	`917`	`* @returns arithmetic mean`
`918`	`918`	`*`
`919`	`919`	`* @example`
`@@ -2295,7 +2295,7 @@ interface Namespace {`
`2295`	`2295`	`* @param N - number of indexed elements`
`2296`	`2296`	`* @param correction - degrees of freedom adjustment`
`2297`	`2297`	`* @param x - input array`
`2298`		`- * @param stride - stride length`
	`2298`	`+ * @param strideX - stride length`
`2299`	`2299`	`* @returns standard deviation`
`2300`	`2300`	`*`
`2301`	`2301`	`* @example`
`@@ -2349,7 +2349,7 @@ interface Namespace {`
`2349`	`2349`	`* @param N - number of indexed elements`
`2350`	`2350`	`* @param correction - degrees of freedom adjustment`
`2351`	`2351`	`* @param x - input array`
`2352`		`- * @param stride - stride length`
	`2352`	`+ * @param strideX - stride length`
`2353`	`2353`	`* @returns standard deviation`
`2354`	`2354`	`*`
`2355`	`2355`	`* @example`
`@@ -2376,7 +2376,7 @@ interface Namespace {`
`2376`	`2376`	`* @param N - number of indexed elements`
`2377`	`2377`	`* @param correction - degrees of freedom adjustment`
`2378`	`2378`	`* @param x - input array`
`2379`		`- * @param stride - stride length`
	`2379`	`+ * @param strideX - stride length`
`2380`	`2380`	`* @returns standard deviation`
`2381`	`2381`	`*`
`2382`	`2382`	`* @example`
`@@ -2403,23 +2403,23 @@ interface Namespace {`
`2403`	`2403`	`* @param N - number of indexed elements`
`2404`	`2404`	`* @param correction - degrees of freedom adjustment`
`2405`	`2405`	`* @param x - input array`
`2406`		`- * @param stride - stride length`
	`2406`	`+ * @param strideX - stride length`
`2407`	`2407`	`* @returns standard deviation`
`2408`	`2408`	`*`
`2409`	`2409`	`* @example`
`2410`	`2410`	`* var Float64Array = require( '@stdlib/array/float64' );`
`2411`	`2411`	`*`
`2412`	`2412`	`* var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );`
`2413`	`2413`	`*`
`2414`		`- * var v = ns.dstdevyc( x.length, 1, x, 1 );`
	`2414`	`+ * var v = ns.dstdevyc( x.length, 1.0, x, 1 );`
`2415`	`2415`	`* // returns ~2.0817`
`2416`	`2416`	`*`
`2417`	`2417`	`* @example`
`2418`	`2418`	`* var Float64Array = require( '@stdlib/array/float64' );`
`2419`	`2419`	`*`
`2420`	`2420`	`* var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );`
`2421`	`2421`	`*`
`2422`		`- * var v = ns.dstdevyc.ndarray( x.length, 1, x, 1, 0 );`
	`2422`	`+ * var v = ns.dstdevyc.ndarray( x.length, 1.0, x, 1, 0 );`
`2423`	`2423`	`* // returns ~2.0817`
`2424`	`2424`	`*/`
`2425`	`2425`	`dstdevyc: typeof dstdevyc;`