docs: clean-up TSDoc declaration comments

Planeshifter · Planeshifter · commit b7c20312491b · 2025-09-29T00:27:55.000-05:00
diff --git a/lib/node_modules/@stdlib/blas/base/snrm2/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/base/snrm2/docs/types/index.d.ts
@@ -54,7 +54,7 @@ interface Routine {
 	*
 	* var x = new Float32Array( [ 1.0, -2.0, 2.0 ] );
 	*
-	* var z = snrm2.ndarray( x.length, x, 1, - );
+	* var z = snrm2.ndarray( x.length, x, 1, 0 );
 	* // returns 3.0
 	*/
 	ndarray( N: number, x: Float32Array, stride: number, offset: number ): number;
diff --git a/lib/node_modules/@stdlib/blas/base/sspr/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/base/sspr/docs/types/index.d.ts
@@ -45,7 +45,7 @@ interface Routine {
 	* var x = new Float32Array( [ 1.0, 2.0, 3.0 ] );
 	*
 	* sspr( 'row-major', 'upper', 3, 1.0, x, 1, AP );
-	* // A => <Float32Array>[ 2.0, 4.0, 6.0, 5.0, 8.0, 10.0 ]
+	* // AP => <Float32Array>[ 2.0, 4.0, 6.0, 5.0, 8.0, 10.0 ]
 	*/
 	( order: Layout, uplo: MatrixTriangle, N: number, alpha: number, x: Float32Array, strideX: number, AP: Float32Array ): Float32Array;
 
@@ -71,7 +71,7 @@ interface Routine {
 	* var x = new Float32Array( [ 1.0, 2.0, 3.0 ] );
 	*
 	* sspr.ndarray( 'row-major', 'upper', 3, 1.0, x, 1, 0, AP, 1, 0 );
-	* // A => <Float32Array>[ 2.0, 4.0, 6.0, 5.0, 8.0, 10.0 ]
+	* // AP => <Float32Array>[ 2.0, 4.0, 6.0, 5.0, 8.0, 10.0 ]
 	*/
 	ndarray( order: Layout, uplo: MatrixTriangle, N: number, alpha: number, x: Float32Array, strideX: number, offsetX: number, AP: Float32Array, strideAP: number, offsetAP: number ): Float32Array;
 }
diff --git a/lib/node_modules/@stdlib/iter/do-until-each/docs/types/index.d.ts b/lib/node_modules/@stdlib/iter/do-until-each/docs/types/index.d.ts
@@ -116,9 +116,9 @@ type Predicate = nullaryPredicate | unaryPredicate | binaryPredicate;
 *     return v > 2;
 * }
 *
-* function assert( v, i ) {
-*     if ( i > 1 ) {
-*         throw new Error( 'unexpected error' );
+* function assert( v ) {
+*     if ( v !== v ) {
+*         throw new Error( 'should not be NaN' );
 *     }
 * }
 *
diff --git a/lib/node_modules/@stdlib/iter/do-until-each/docs/types/test.ts b/lib/node_modules/@stdlib/iter/do-until-each/docs/types/test.ts
@@ -57,7 +57,6 @@ function predicate( v: unknown, i: number ): boolean {
 *
 * @param v - iterated value
 * @param i - iteration index
-* @returns callback result
 */
 function fcn( v: unknown, i: number ): void {
 	if ( v !== v || i !== i ) {
diff --git a/lib/node_modules/@stdlib/iter/do-while-each/docs/types/index.d.ts b/lib/node_modules/@stdlib/iter/do-while-each/docs/types/index.d.ts
@@ -117,9 +117,9 @@ type Predicate = nullaryPredicate | unaryPredicate | binaryPredicate;
 *     return v < 3;
 * }
 *
-* function assert( v, i ) {
-*     if ( i > 1 ) {
-*         throw new Error( 'unexpected error' );
+* function assert( v ) {
+*     if ( v !== v ) {
+*         throw new Error( 'should not be NaN' );
 *     }
 * }
 *
diff --git a/lib/node_modules/@stdlib/iter/do-while-each/docs/types/test.ts b/lib/node_modules/@stdlib/iter/do-while-each/docs/types/test.ts
@@ -57,7 +57,6 @@ function predicate( v: any, i: number ): boolean {
 *
 * @param v - iterated value
 * @param i - iteration index
-* @returns callback result
 */
 function fcn( v: any, i: number ): any {
 	if ( v !== v || i !== i ) {
diff --git a/lib/node_modules/@stdlib/iter/logspace/docs/types/index.d.ts b/lib/node_modules/@stdlib/iter/logspace/docs/types/index.d.ts
@@ -52,7 +52,7 @@ interface Options {
 * @returns iterator
 *
 * @example
-* var iter = iterLogspace( 0, 1000, 4 );
+* var iter = iterLogspace( 0, 3, 4 );
 *
 * var v = iter.next().value;
 * // returns 1
diff --git a/lib/node_modules/@stdlib/iter/strided-by/docs/types/index.d.ts b/lib/node_modules/@stdlib/iter/strided-by/docs/types/index.d.ts
@@ -117,10 +117,10 @@ type Callback = Nullary | Unary | Binary | Ternary | Quaternary;
 * // returns 1
 *
 * r = iter.next().value;
-* // returns 2
+* // returns 3
 *
 * r = iter.next().value;
-* // returns 4
+* // returns 7
 *
 * // ...
 */
@@ -161,10 +161,10 @@ declare function iterStridedBy( iterator: Iterator, fcn: Callback, offset?: numb
 * // returns 1
 *
 * r = iter.next().value;
-* // returns 2
+* // returns 3
 *
 * r = iter.next().value;
-* // returns 4
+* // returns 7
 *
 * // ...
 */
@@ -207,7 +207,7 @@ declare function iterStridedBy( iterator: Iterator, fcn: Callback, offset?: numb
 * // returns 1
 *
 * r = iter.next().value;
-* // returns 2
+* // returns 3
 *
 * // ...
 */
diff --git a/lib/node_modules/@stdlib/lapack/base/crot/docs/types/index.d.ts b/lib/node_modules/@stdlib/lapack/base/crot/docs/types/index.d.ts
@@ -41,7 +41,7 @@ interface Routine {
 	*
 	* @example
 	* var Complex64Array = require( '@stdlib/array/complex64' );
-	* var Complex64 = require( '@stdlib/complex/float32' );
+	* var Complex64 = require( '@stdlib/complex/float32/ctor' );
 	* var realf = require( '@stdlib/complex/float32/real' );
 	* var imagf = require( '@stdlib/complex/float32/imag' );
 	*
@@ -87,7 +87,7 @@ interface Routine {
 	*
 	* @example
 	* var Complex64Array = require( '@stdlib/array/complex64' );
-	* var Complex64 = require( '@stdlib/complex/float32' );
+	* var Complex64 = require( '@stdlib/complex/float32/ctor' );
 	* var realf = require( '@stdlib/complex/float32/real' );
 	* var imagf = require( '@stdlib/complex/float32/imag' );
 	*
@@ -132,7 +132,7 @@ interface Routine {
 *
 * @example
 * var Complex64Array = require( '@stdlib/array/complex64' );
-* var Complex64 = require( '@stdlib/complex/float32' );
+* var Complex64 = require( '@stdlib/complex/float32/ctor' );
 * var realf = require( '@stdlib/complex/float32/real' );
 * var imagf = require( '@stdlib/complex/float32/imag' );
 *
@@ -162,7 +162,7 @@ interface Routine {
 *
 * @example
 * var Complex64Array = require( '@stdlib/array/complex64' );
-* var Complex64 = require( '@stdlib/complex/float32' );
+* var Complex64 = require( '@stdlib/complex/float32/ctor' );
 * var realf = require( '@stdlib/complex/float32/real' );
 * var imagf = require( '@stdlib/complex/float32/imag' );
 *
diff --git a/lib/node_modules/@stdlib/lapack/base/zrot/docs/types/index.d.ts b/lib/node_modules/@stdlib/lapack/base/zrot/docs/types/index.d.ts
@@ -41,7 +41,7 @@ interface Routine {
 	*
 	* @example
 	* var Complex128Array = require( '@stdlib/array/complex128' );
-	* var Complex128 = require( '@stdlib/complex/float64' );
+	* var Complex128 = require( '@stdlib/complex/float64/ctor' );
 	* var real = require( '@stdlib/complex/float64/real' );
 	* var imag = require( '@stdlib/complex/float64/imag' );
 	*
@@ -87,7 +87,7 @@ interface Routine {
 	*
 	* @example
 	* var Complex128Array = require( '@stdlib/array/complex128' );
-	* var Complex128 = require( '@stdlib/complex/float64' );
+	* var Complex128 = require( '@stdlib/complex/float64/ctor' );
 	* var real = require( '@stdlib/complex/float64/real' );
 	* var imag = require( '@stdlib/complex/float64/imag' );
 	*
@@ -132,7 +132,7 @@ interface Routine {
 *
 * @example
 * var Complex128Array = require( '@stdlib/array/complex128' );
-* var Complex128 = require( '@stdlib/complex/float64' );
+* var Complex128 = require( '@stdlib/complex/float64/ctor' );
 * var real = require( '@stdlib/complex/float64/real' );
 * var imag = require( '@stdlib/complex/float64/imag' );
 *
@@ -162,7 +162,7 @@ interface Routine {
 *
 * @example
 * var Complex128Array = require( '@stdlib/array/complex128' );
-* var Complex128 = require( '@stdlib/complex/float64' );
+* var Complex128 = require( '@stdlib/complex/float64/ctor' );
 * var real = require( '@stdlib/complex/float64/real' );
 * var imag = require( '@stdlib/complex/float64/imag' );
 *
diff --git a/lib/node_modules/@stdlib/math/iter/sequences/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/iter/sequences/docs/types/index.d.ts
@@ -910,7 +910,7 @@ interface Namespace {
 	* // returns 1
 	*
 	* v = iter.next().value;
-	* // returns 2
+	* // returns 1
 	*
 	* // ...
 	*/
diff --git a/lib/node_modules/@stdlib/math/iter/sequences/tribonacci/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/iter/sequences/tribonacci/docs/types/index.d.ts
@@ -62,7 +62,7 @@ interface Options {
 * // returns 1
 *
 * v = iter.next().value;
-* // returns 2
+* // returns 1
 *
 * // ...
 */
diff --git a/lib/node_modules/@stdlib/math/iter/utils/continued-fraction/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/iter/utils/continued-fraction/docs/types/index.d.ts
@@ -50,7 +50,7 @@ interface Options {
 *
 * @example
 * // Create an iterator for generating continued fraction terms:
-* var it = iterContinuedFractionSeq( 3.245 );
+* var it = iterContinuedFraction( 3.245 );
 *
 * // Reconstruct the original value from the terms:
 * var v = iterContinuedFraction( it );
diff --git a/lib/node_modules/@stdlib/math/iter/utils/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/iter/utils/docs/types/index.d.ts
@@ -39,7 +39,7 @@ interface Namespace {
 	*
 	* @example
 	* // Create an iterator for generating continued fraction terms:
-	* var it = iterContinuedFractionSeq( 3.245 );
+	* var it = ns.iterContinuedFraction( 3.245 );
 	*
 	* // Reconstruct the original value from the terms:
 	* var v = ns.iterContinuedFraction( it );
diff --git a/lib/node_modules/@stdlib/math/tools/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/tools/docs/types/index.d.ts
@@ -38,7 +38,7 @@ interface Namespace {
 	* @example
 	* var base = require( '@stdlib/math/base/special/abs' );
 	* var dispatch = require( '@stdlib/ndarray/dispatch' );
-	* var ns.unary = require( '@stdlib/ndarray/base/ns.unary' );
+	* var unary = require( '@stdlib/ndarray/base/unary' );
 	* var ndarray2array = require( '@stdlib/ndarray/to-array' );
 	* var array = require( '@stdlib/ndarray/array' );
 	*
diff --git a/lib/node_modules/@stdlib/stats/incr/mminmax/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/incr/mminmax/docs/types/index.d.ts
@@ -56,19 +56,19 @@ type accumulator = ( x?: number ) => ArrayLike<number> | null;
 * // returns null
 *
 * mm = accumulator( 2.0 );
-* // returns [ 2.0, 2.0 ]
+* // returns Float64Array<[ 2.0, 2.0 ]>
 *
 * mm = accumulator( -5.0 );
-* // returns [ -5.0, 2.0 ]
+* // returns Float64Array<[ -5.0, 2.0 ]>
 *
 * mm = accumulator( 3.0 );
-* // returns [ -5.0, 3.0 ]
+* // returns Float64Array<[ -5.0, 3.0 ]>
 *
 * mm = accumulator( 5.0 );
-* // returns [ -5.0, 5.0 ]
+* // returns Float64Array<[ -5.0, 5.0 ]>
 *
 * mm = accumulator();
-* // returns [ -5.0, 5.0 ]
+* // returns Float64Array<[ -5.0, 5.0 ]>
 */
 declare function incrmminmax( out: ArrayLike<number>, window: number ): accumulator;
 
diff --git a/lib/node_modules/@stdlib/utils/async/docs/types/index.d.ts b/lib/node_modules/@stdlib/utils/async/docs/types/index.d.ts
@@ -1128,8 +1128,6 @@ interface Namespace {
 	* @param clbk - callback to invoke upon completion
 	*
 	* @example
-	* var ns.parallel = require( '@stdlib/utils/async/ns.parallel' );
-	*
 	* function foo( clbk ) {
 	*     setTimeout( onTimeout, 300 );
 	*     function onTimeout() {
diff --git a/lib/node_modules/@stdlib/utils/async/map-function/docs/types/index.d.ts b/lib/node_modules/@stdlib/utils/async/map-function/docs/types/index.d.ts
@@ -250,7 +250,7 @@ interface MapFunAsync {
 	*     }
 	* }
 	*
-	* var map = mapFunAsync.factory( fcn );
+	* var mapFun = mapFunAsync.factory( fcn );
 	*
 	* function done( error, results ) {
 	*     if ( error ) {
@@ -259,7 +259,7 @@ interface MapFunAsync {
 	*     console.log( results );
 	* }
 	*
-	* mapFunAsync( 10, done );
+	* mapFun( 10, done );
 	*/
 	factory( fcn: Fcn ): FactoryFunction;
 }
diff --git a/lib/node_modules/@stdlib/utils/map-arguments/docs/types/index.d.ts b/lib/node_modules/@stdlib/utils/map-arguments/docs/types/index.d.ts
@@ -30,7 +30,6 @@
 *
 * @param fcn - input function
 * @param clbk - callback function
-* @param thisArg - input function context
 * @returns function wrapper
 *
 * @example

Original file line number	Diff line number	Diff line change
`@@ -54,7 +54,7 @@ interface Routine {`
`54`	`54`	`*`
`55`	`55`	`* var x = new Float32Array( [ 1.0, -2.0, 2.0 ] );`
`56`	`56`	`*`
`57`		`- * var z = snrm2.ndarray( x.length, x, 1, - );`
	`57`	`+ * var z = snrm2.ndarray( x.length, x, 1, 0 );`
`58`	`58`	`* // returns 3.0`
`59`	`59`	`*/`
`60`	`60`	`ndarray( N: number, x: Float32Array, stride: number, offset: number ): number;`
Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ interface Routine {`
`45`	`45`	`* var x = new Float32Array( [ 1.0, 2.0, 3.0 ] );`
`46`	`46`	`*`
`47`	`47`	`* sspr( 'row-major', 'upper', 3, 1.0, x, 1, AP );`
`48`		`- * // A => <Float32Array>[ 2.0, 4.0, 6.0, 5.0, 8.0, 10.0 ]`
	`48`	`+ * // AP => <Float32Array>[ 2.0, 4.0, 6.0, 5.0, 8.0, 10.0 ]`
`49`	`49`	`*/`
`50`	`50`	`( order: Layout, uplo: MatrixTriangle, N: number, alpha: number, x: Float32Array, strideX: number, AP: Float32Array ): Float32Array;`
`51`	`51`
`@@ -71,7 +71,7 @@ interface Routine {`
`71`	`71`	`* var x = new Float32Array( [ 1.0, 2.0, 3.0 ] );`
`72`	`72`	`*`
`73`	`73`	`* sspr.ndarray( 'row-major', 'upper', 3, 1.0, x, 1, 0, AP, 1, 0 );`
`74`		`- * // A => <Float32Array>[ 2.0, 4.0, 6.0, 5.0, 8.0, 10.0 ]`
	`74`	`+ * // AP => <Float32Array>[ 2.0, 4.0, 6.0, 5.0, 8.0, 10.0 ]`
`75`	`75`	`*/`
`76`	`76`	`ndarray( order: Layout, uplo: MatrixTriangle, N: number, alpha: number, x: Float32Array, strideX: number, offsetX: number, AP: Float32Array, strideAP: number, offsetAP: number ): Float32Array;`
`77`	`77`	`}`
Original file line number	Diff line number	Diff line change
`@@ -116,9 +116,9 @@ type Predicate = nullaryPredicate \| unaryPredicate \| binaryPredicate;`
`116`	`116`	`* return v > 2;`
`117`	`117`	`* }`
`118`	`118`	`*`
`119`		`-* function assert( v, i ) {`
`120`		`-* if ( i > 1 ) {`
`121`		`-* throw new Error( 'unexpected error' );`
	`119`	`+* function assert( v ) {`
	`120`	`+* if ( v !== v ) {`
	`121`	`+* throw new Error( 'should not be NaN' );`
`122`	`122`	`* }`
`123`	`123`	`* }`
`124`	`124`	`*`
Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,6 @@ function predicate( v: unknown, i: number ): boolean {`
`57`	`57`	`*`
`58`	`58`	`* @param v - iterated value`
`59`	`59`	`* @param i - iteration index`
`60`		`-* @returns callback result`
`61`	`60`	`*/`
`62`	`61`	`function fcn( v: unknown, i: number ): void {`
`63`	`62`	`if ( v !== v \|\| i !== i ) {`
Original file line number	Diff line number	Diff line change
`@@ -117,9 +117,9 @@ type Predicate = nullaryPredicate \| unaryPredicate \| binaryPredicate;`
`117`	`117`	`* return v < 3;`
`118`	`118`	`* }`
`119`	`119`	`*`
`120`		`-* function assert( v, i ) {`
`121`		`-* if ( i > 1 ) {`
`122`		`-* throw new Error( 'unexpected error' );`
	`120`	`+* function assert( v ) {`
	`121`	`+* if ( v !== v ) {`
	`122`	`+* throw new Error( 'should not be NaN' );`
`123`	`123`	`* }`
`124`	`124`	`* }`
`125`	`125`	`*`
Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,7 @@ interface Options {`
`52`	`52`	`* @returns iterator`
`53`	`53`	`*`
`54`	`54`	`* @example`
`55`		`-* var iter = iterLogspace( 0, 1000, 4 );`
	`55`	`+* var iter = iterLogspace( 0, 3, 4 );`
`56`	`56`	`*`
`57`	`57`	`* var v = iter.next().value;`
`58`	`58`	`* // returns 1`
Original file line number	Diff line number	Diff line change
`@@ -117,10 +117,10 @@ type Callback = Nullary \| Unary \| Binary \| Ternary \| Quaternary;`
`117`	`117`	`* // returns 1`
`118`	`118`	`*`
`119`	`119`	`* r = iter.next().value;`
`120`		`-* // returns 2`
	`120`	`+* // returns 3`
`121`	`121`	`*`
`122`	`122`	`* r = iter.next().value;`
`123`		`-* // returns 4`
	`123`	`+* // returns 7`
`124`	`124`	`*`
`125`	`125`	`* // ...`
`126`	`126`	`*/`
`@@ -161,10 +161,10 @@ declare function iterStridedBy( iterator: Iterator, fcn: Callback, offset?: numb`
`161`	`161`	`* // returns 1`
`162`	`162`	`*`
`163`	`163`	`* r = iter.next().value;`
`164`		`-* // returns 2`
	`164`	`+* // returns 3`
`165`	`165`	`*`
`166`	`166`	`* r = iter.next().value;`
`167`		`-* // returns 4`
	`167`	`+* // returns 7`
`168`	`168`	`*`
`169`	`169`	`* // ...`
`170`	`170`	`*/`
`@@ -207,7 +207,7 @@ declare function iterStridedBy( iterator: Iterator, fcn: Callback, offset?: numb`
`207`	`207`	`* // returns 1`
`208`	`208`	`*`
`209`	`209`	`* r = iter.next().value;`
`210`		`-* // returns 2`
	`210`	`+* // returns 3`
`211`	`211`	`*`
`212`	`212`	`* // ...`
`213`	`213`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ interface Routine {`
`41`	`41`	`*`
`42`	`42`	`* @example`
`43`	`43`	`* var Complex64Array = require( '@stdlib/array/complex64' );`
`44`		`- * var Complex64 = require( '@stdlib/complex/float32' );`
	`44`	`+ * var Complex64 = require( '@stdlib/complex/float32/ctor' );`
`45`	`45`	`* var realf = require( '@stdlib/complex/float32/real' );`
`46`	`46`	`* var imagf = require( '@stdlib/complex/float32/imag' );`
`47`	`47`	`*`
`@@ -87,7 +87,7 @@ interface Routine {`
`87`	`87`	`*`
`88`	`88`	`* @example`
`89`	`89`	`* var Complex64Array = require( '@stdlib/array/complex64' );`
`90`		`- * var Complex64 = require( '@stdlib/complex/float32' );`
	`90`	`+ * var Complex64 = require( '@stdlib/complex/float32/ctor' );`
`91`	`91`	`* var realf = require( '@stdlib/complex/float32/real' );`
`92`	`92`	`* var imagf = require( '@stdlib/complex/float32/imag' );`
`93`	`93`	`*`
`@@ -132,7 +132,7 @@ interface Routine {`
`132`	`132`	`*`
`133`	`133`	`* @example`
`134`	`134`	`* var Complex64Array = require( '@stdlib/array/complex64' );`
`135`		`-* var Complex64 = require( '@stdlib/complex/float32' );`
	`135`	`+* var Complex64 = require( '@stdlib/complex/float32/ctor' );`
`136`	`136`	`* var realf = require( '@stdlib/complex/float32/real' );`
`137`	`137`	`* var imagf = require( '@stdlib/complex/float32/imag' );`
`138`	`138`	`*`
`@@ -162,7 +162,7 @@ interface Routine {`
`162`	`162`	`*`
`163`	`163`	`* @example`
`164`	`164`	`* var Complex64Array = require( '@stdlib/array/complex64' );`
`165`		`-* var Complex64 = require( '@stdlib/complex/float32' );`
	`165`	`+* var Complex64 = require( '@stdlib/complex/float32/ctor' );`
`166`	`166`	`* var realf = require( '@stdlib/complex/float32/real' );`
`167`	`167`	`* var imagf = require( '@stdlib/complex/float32/imag' );`
`168`	`168`	`*`