Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -4,7 +4,7 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2025-11-13)
+## Unreleased (2025-11-25)
 
 <section class="features">
 
@@ -256,6 +256,10 @@ A total of 33 issues were closed in this release:
 
 <details>
 
+-   [`c520b5a`](https://github.com/stdlib-js/stdlib/commit/c520b5a0cae0c85e946f8a646e7cc8c01b3b5673) - **docs:** address TSDoc lint errors and add doctest aliases _(by Philipp Burckhardt)_
+-   [`3f7b1ed`](https://github.com/stdlib-js/stdlib/commit/3f7b1ed405cdb77a3357d424f462e8d3b2276df5) - **docs:** fix code in TSDoc examples _(by Philipp Burckhardt)_
+-   [`7f55434`](https://github.com/stdlib-js/stdlib/commit/7f554349e50fc601e7ab4206ba1da0eceae93518) - **docs:** fix TSDoc comments example code and return annotation values _(by Philipp Burckhardt)_
+-   [`47088cc`](https://github.com/stdlib-js/stdlib/commit/47088cc299d84289a904dd2e7d2cdf0aee9057aa) - **docs:** fix TSDoc comments example code and return annotation values _(by Philipp Burckhardt)_
 -   [`ff50310`](https://github.com/stdlib-js/stdlib/commit/ff5031015827c1783e8b7b62713361ca6c7bc655) - **chore:** fix lint errors _(by Philipp Burckhardt)_
 -   [`e4d5f21`](https://github.com/stdlib-js/stdlib/commit/e4d5f21b9a7111bb6255874d2f7a2d5a0c08e59e) - **docs:** fix lint errors in TS declaration files _(by Philipp Burckhardt)_
 -   [`5f5bb2d`](https://github.com/stdlib-js/stdlib/commit/5f5bb2d4277a24000b57fb07bc28d821500cd7e8) - **docs:** update namespace table of contents [(#8425)](https://github.com/stdlib-js/stdlib/pull/8425) _(by stdlib-bot, Athan Reines)_

base/cuany-by-right/docs/types/index.d.ts

@@ -157,7 +157,7 @@ interface CuanyByRight {
 	* var y = [ false, null, false, null, false, null, false, null, false, null ];
 	*
 	* var arr = cuanyByRight.assign( x, y, 2, 0, isPositive );
-	* // returns [ false, null, false, null, false, null, true, null, true, null ]
+	* // returns [ false, null, ..., true, null ]
 	*/
 	assign<T = unknown, U = unknown, V = unknown>( x: Collection<T> | AccessorArrayLike<T>, out: Collection<U> | AccessorArrayLike<U>, stride: number, offset: number, predicate: Predicate<T, V>, thisArg?: ThisParameterType<Predicate<T, V>> ): Collection<U | boolean> | AccessorArrayLike<U | boolean>;
 }
@@ -187,7 +187,7 @@ interface CuanyByRight {
 * var y = [ false, null, false, null, false, null, false, null, false, null ];
 *
 * var arr = cuanyByRight.assign( x, y, 2, 0, isPositive );
-* // returns [ false, null, false, null, false, null, true, null, true, null ]
+* // returns [ false, null, ..., true, null ]
 */
 declare var cuanyByRight: CuanyByRight;
 

base/resolve-setter/docs/types/index.d.ts

@@ -201,16 +201,16 @@ declare function resolveSetter( x: Float32Array ): SetFloat32;
 * var resolveGetter = require( '@stdlib/array/base/resolve-getter' );
 * var Complex128Array = require( '@stdlib/array/complex128' );
 * var Complex128 = require( '@stdlib/complex/float64/ctor' );
-* var real = require( '@stdlib/array/real' );
-* var imag = require( '@stdlib/array/imag' );
+* var real = require( '@stdlib/complex/float64/real' );
+* var imag = require( '@stdlib/complex/float64/imag' );
 *
 * var arr = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] );
 *
 * var set = resolveSetter( arr );
 * set( arr, 1, new Complex128( 10.0, 11.0 ) );
 *
 * var get = resolveGetter( arr );
-* var v = get( arr, 2 );
+* var v = get( arr, 1 );
 * // returns <Complex128>
 *
 * var re = real( v );
@@ -231,16 +231,16 @@ declare function resolveSetter( x: Complex128Array ): SetComplex128;
 * var resolveGetter = require( '@stdlib/array/base/resolve-getter' );
 * var Complex64Array = require( '@stdlib/array/complex64' );
 * var Complex64 = require( '@stdlib/complex/float32/ctor' );
-* var realf = require( '@stdlib/array/realf' );
-* var imagf = require( '@stdlib/array/imagf' );
+* var realf = require( '@stdlib/complex/float32/real' );
+* var imagf = require( '@stdlib/complex/float32/imag' );
 *
 * var arr = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0 ] );
 *
 * var set = resolveSetter( arr );
 * set( arr, 1, new Complex64( 10.0, 11.0 ) );
 *
 * var get = resolveGetter( arr );
-* var v = get( arr, 2 );
+* var v = get( arr, 1 );
 * // returns <Complex64>
 *
 * var re = realf( v );

base/unary4d-by/docs/types/index.d.ts

@@ -104,7 +104,7 @@ type Unary<U, V> = ( value: U ) => V;
 * var x = ones4d( shape );
 * var y = zeros4d( shape );
 *
-* unary4dBy( [ x, y ], shape, scale );
+* unary4dBy( [ x, y ], shape, scale, accessor );
 *
 * console.log( y );
 * // => [ [ [ [ -10.0, -10.0 ], [ -10.0, -10.0 ] ] ] ]

complex64/docs/types/index.d.ts

@@ -357,8 +357,8 @@ declare class Complex64Array implements Complex64ArrayInterface {
 	* arr.set( [ 1.0, -1.0 ], 0 );
 	* arr.set( [ 9.0, -9.0 ], 9 );
 	*
-	* z = arr.get( -1 )
-	* // return <Complex64>
+	* z = arr.at( -1 );
+	* // returns <Complex64>
 	*
 	* z = arr.at( 100 );
 	* // returns undefined
@@ -732,9 +732,6 @@ declare class Complex64Array implements Complex64ArrayInterface {
 	* arr.set( [ 3.0, 3.0 ], 2 );
 	*
 	* arr.forEach( log );
-	* // => 0: 1 + 1i
-	* // => 1: 2 + 2i
-	* // => 2: 3 + 3i
 	*/
 	forEach<U = unknown>( fcn: Callback<U>, thisArg?: ThisParameterType<Callback<U>> ): void;
 
@@ -801,13 +798,13 @@ declare class Complex64Array implements Complex64ArrayInterface {
 	* arr.set( [ 2.0, 2.0 ], 3 );
 	* arr.set( [ 5.0, 5.0 ], 4 );
 	*
-	* var idx = arr.indexOf( new Complex64( [ 2.0, 2.0 ] ) );
+	* var idx = arr.indexOf( new Complex64( 2.0, 2.0 ) );
 	* // returns 1
 	*
-	* idx = arr.indexOf( new Complex64( [ 2.0, 2.0 ] ), 2 );
+	* idx = arr.indexOf( new Complex64( 2.0, 2.0 ), 2 );
 	* // returns 3
 	*
-	* idx = arr.indexOf( new Complex64( [ 2.0, 2.0 ] ), -3 );
+	* idx = arr.indexOf( new Complex64( 2.0, 2.0 ), -3 );
 	* // returns 3
 	*/
 	indexOf( searchElement: ComplexLike, fromIndex?: number ): number;
@@ -1843,3 +1840,5 @@ declare var ctor: Complex64ArrayConstructor;
 // EXPORTS //
 
 export = ctor;
+
+// eslint-doctest-alias: Complex64Array

docs/types/index.d.ts

@@ -357,21 +357,21 @@ interface Namespace {
 	*
 	* @example
 	* var arr = new ns.Complex128Array();
-	* // returns <ns.Complex128Array>
+	* // returns <Complex128Array>
 	*
 	* var len = arr.length;
 	* // returns 0
 	*
 	* @example
 	* var arr = new ns.Complex128Array( 2 );
-	* // returns <ns.Complex128Array>
+	* // returns <Complex128Array>
 	*
 	* var len = arr.length;
 	* // returns 2
 	*
 	* @example
 	* var arr = new ns.Complex128Array( [ 1.0, -1.0 ] );
-	* // returns <ns.Complex128Array>
+	* // returns <Complex128Array>
 	*
 	* var len = arr.length;
 	* // returns 1
@@ -381,27 +381,27 @@ interface Namespace {
 	*
 	* var buf = new ArrayBuffer( 16 );
 	* var arr = new ns.Complex128Array( buf );
-	* // returns <ns.Complex128Array>
+	* // returns <Complex128Array>
 	*
 	* var len = arr.length;
-	* // returns 2
+	* // returns 1
 	*
 	* @example
 	* var ArrayBuffer = require( './../../buffer' );
 	*
-	* var buf = new ArrayBuffer( 16 );
-	* var arr = new ns.Complex128Array( buf, 8 );
-	* // returns <ns.Complex128Array>
+	* var buf = new ArrayBuffer( 32 );
+	* var arr = new ns.Complex128Array( buf, 16 );
+	* // returns <Complex128Array>
 	*
 	* var len = arr.length;
 	* // returns 1
 	*
 	* @example
 	* var ArrayBuffer = require( './../../buffer' );
 	*
-	* var buf = new ArrayBuffer( 32 );
-	* var arr = new ns.Complex128Array( buf, 8, 2 );
-	* // returns <ns.Complex128Array>
+	* var buf = new ArrayBuffer( 48 );
+	* var arr = new ns.Complex128Array( buf, 16, 2 );
+	* // returns <Complex128Array>
 	*
 	* var len = arr.length;
 	* // returns 2
@@ -668,7 +668,7 @@ interface Namespace {
 	*
 	* var out = new Float64Array( 10 );
 	* var arr = ns.iterator2array( iter, out, scale );
-	* // returns <Array>
+	* // returns <Float64Array>
 	*/
 	iterator2array: typeof iterator2array;
 
@@ -1287,19 +1287,19 @@ interface Namespace {
 	* @example
 	* var arr = [ [ 1, 2, 3 ], [ 4, 5, 6 ], [ 7, 8, 9 ] ];
 	*
-	* var ns.shape = ns.shape( arr );
+	* var sh = ns.shape( arr );
 	* // returns [ 3, 3 ]
 	*
 	* @example
 	* var arr = [ [ 1, 2, 3 ], [ 4, 5, 6 ], [ 7, 8 ] ];
 	*
-	* var ns.shape = ns.shape( arr );
+	* var sh = ns.shape( arr );
 	* // returns [ 3 ]
 	*
 	* @example
 	* var arr = [ [ 1, 2, 3 ], [ 4, 5, 6 ], null ];
 	*
-	* var ns.shape = ns.shape( arr );
+	* var sh = ns.shape( arr );
 	* // returns [ 3 ]
 	*/
 	shape: typeof shape;

from-iterator/docs/types/index.d.ts

@@ -118,7 +118,7 @@ declare function iterator2array<T = unknown, U = unknown, W = unknown>( iterator
 *
 * var out = new Float64Array( 10 );
 * var arr = iterator2array( iter, out );
-* // returns <Array>
+* // returns <Float64Array>
 */
 declare function iterator2array<T = unknown, U = unknown>( iterator: Iterator<T>, out: Collection<U> ): Collection<T | U>;
 
@@ -145,7 +145,7 @@ declare function iterator2array<T = unknown, U = unknown>( iterator: Iterator<T>
 *
 * var out = new Float64Array( 10 );
 * var arr = iterator2array( iter, out, scale );
-* // returns <Array>
+* // returns <Float64Array>
 */
 declare function iterator2array<T = unknown, U = unknown, V = unknown, W = unknown>( iterator: Iterator<T>, out: Collection<V>, mapFcn: MapFunction<T, U, W>, thisArg?: ThisParameterType<MapFunction<T, U, W>> ): Collection<U | V>;
 

from-scalar/docs/types/index.d.ts

@@ -191,7 +191,7 @@ declare function scalar2array( value: number, dtype: 'uint8' ): Uint8Array;
 *
 * @example
 * var x = scalar2array( 1, 'uint8c' );
-* // returns <Uint8ClampedArray>[]
+* // returns <Uint8ClampedArray>[ 1 ]
 */
 declare function scalar2array( value: number, dtype: 'uint8c' ): Uint8ClampedArray;
 

index/docs/types/index.d.ts

@@ -323,3 +323,5 @@ declare var ctor: Constructor;
 // EXPORTS //
 
 export = ctor;
+
+// eslint-doctest-alias: ArrayIndex