Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -4,7 +4,7 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2025-12-02)
+## Unreleased (2025-12-04)
 
 <section class="features">
 
@@ -644,6 +644,9 @@ A total of 35 issues were closed in this release:
 
 <details>
 
+- [`4d90d1a`](https://github.com/stdlib-js/stdlib/commit/4d90d1a8908b2328735f43fccaca8e9a1daffb35) - **docs:** fix example code in TSDoc declarations _(by Philipp Burckhardt)_
+- [`0eda9b1`](https://github.com/stdlib-js/stdlib/commit/0eda9b1af1d384b1a6be6fe1e80b36a32f69d55c) - **chore:** specify ESLint doctest alias _(by Philipp Burckhardt)_
+- [`2ffc422`](https://github.com/stdlib-js/stdlib/commit/2ffc422e0a5e583d45776ea7efc359186379bb0c) - **docs:** fix TSDoc return annotation values and example code _(by Philipp Burckhardt)_
 - [`e24d1a7`](https://github.com/stdlib-js/stdlib/commit/e24d1a701a3cb60714f3d44c0ff87341dd0d870a) - **feat:** update `ndarray/base/assert` TypeScript declarations _(by Philipp Burckhardt)_
 - [`41bc320`](https://github.com/stdlib-js/stdlib/commit/41bc320db9372557b8eb3341169981c96450b3bf) - **chore:** add alias for doctest lint rule _(by Philipp Burckhardt)_
 - [`5b98eea`](https://github.com/stdlib-js/stdlib/commit/5b98eeaa83f9762c4082b97ba7706fc682685b7c) - **docs:** regenerate TS declarations for `ndarray/vector` namespace _(by Philipp Burckhardt)_

base/broadcast-arrays/docs/types/index.d.ts

@@ -54,7 +54,7 @@ import { ndarray } from '@stdlib/types/ndarray';
 * // returns [ 3, 2, 2 ]
 *
 * var out = broadcastArrays( [ x1, y1 ] );
-* // returns <ndarray>
+* // returns [ <ndarray>, <ndarray> ]
 *
 * var x2 = out[ 0 ];
 * // returns <ndarray>

base/ctor/docs/types/index.d.ts

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

base/ind/docs/types/index.d.ts

@@ -92,51 +92,51 @@ interface Routine {
 * @returns {Function} function for returning an index
 *
 * @example
-* var ind = ind.factory( 'clamp' );
+* var fcn = ind.factory( 'clamp' );
 *
-* var idx = ind( 2, 9 );
+* var idx = fcn( 2, 9 );
 * // returns 2
 *
-* idx = ind( 10, 9 );
+* idx = fcn( 10, 9 );
 * // returns 9
 *
-* idx = ind( -1, 9 );
+* idx = fcn( -1, 9 );
 * // returns 0
 *
 * @example
-* var ind = ind.factory( 'wrap' );
+* var fcn = ind.factory( 'wrap' );
 *
-* var idx = ind( 2, 9 );
+* var idx = fcn( 2, 9 );
 * // returns 2
 *
-* idx = ind( 10, 9 );
+* idx = fcn( 10, 9 );
 * // returns 0
 *
-* idx = ind( -1, 9 );
+* idx = fcn( -1, 9 );
 * // returns 9
 *
 * @example
-* var ind = ind.factory( 'throw' );
+* var fcn = ind.factory( 'throw' );
 *
-* var idx = ind( 2, 9 );
+* var idx = fcn( 2, 9 );
 * // returns 2
 *
-* idx = ind( 10, 9 );
+* idx = fcn( 10, 9 );
 * // throws <RangeError>
 *
-* idx = ind( -1, 9 );
+* idx = fcn( -1, 9 );
 * // throws <RangeError>
 *
 * @example
-* var ind = ind.factory( 'normalize' );
+* var fcn = ind.factory( 'normalize' );
 *
-* var idx = ind( 1, 10 );
+* var idx = fcn( 1, 10 );
 * // returns 1
 *
-* idx = ind( -4, 10 );
+* idx = fcn( -4, 10 );
 * // returns 7
 *
-* idx = ind( -100, 10 );
+* idx = fcn( -100, 10 );
 * // throws <RangeError>
 */
 factory( mode: Mode ): IndexFcn;
@@ -181,26 +181,14 @@ interface Routine {
 * // throws <RangeError>
 *
 * @example
-* var idx = ind( 2, 9, 'normalize' );
-* // returns 2
+* var idx = ind( 1, 10, 'normalize' );
+* // returns 1
 *
-* idx = ind( -5, 9, 'normalize' );
-* // returns 5
+* idx = ind( -4, 10, 'normalize' );
+* // returns 7
 *
-* idx = ind( -20, 9, 'normalize' );
+* idx = ind( -100, 10, 'normalize' );
 * // throws <RangeError>
-*
-* @example
-* var fcn = ind.factory( 'clamp' );
-*
-* var idx = fcn( 2, 9 );
-* // returns 2
-*
-* idx = fcn( 10, 9 );
-* // returns 9
-*
-* idx = fcn( -1, 9 );
-* // returns 0
 */
 declare var ind: Routine;
 

base/nullary-strided1d-dispatch/docs/types/index.d.ts

@@ -112,6 +112,7 @@ declare class NullaryStrided1dDispatch<T, U> {
 * @example
 * var base = require( '@stdlib/blas/ext/base/ndarray/gsorthp' );
 * var dtypes = require( './../../../../dtypes' );
+* var scalar2ndarray = require( './../../../../from-scalar' );
 * var ndarray2array = require( './../../../../to-array' );
 * var ndarray = require( './../../../../base/ctor' );
 *
@@ -149,7 +150,7 @@ declare class NullaryStrided1dDispatch<T, U> {
 * @returns output ndarray
 *
 * @example
-* var base = require( '@stdlib/blas/ext/base/ndarray/sorthp' );
+* var base = require( '@stdlib/blas/ext/base/ndarray/gsorthp' );
 * var dtypes = require( './../../../../dtypes' );
 * var scalar2ndarray = require( './../../../../from-scalar' );
 * var ndarray2array = require( './../../../../to-array' );
@@ -190,7 +191,7 @@ declare class NullaryStrided1dDispatch<T, U> {
 * @returns output ndarray
 *
 * @example
-* var base = require( '@stdlib/blas/ext/base/ndarray/sorthp' );
+* var base = require( '@stdlib/blas/ext/base/ndarray/gsorthp' );
 * var dtypes = require( './../../../../dtypes' );
 * var scalar2ndarray = require( './../../../../from-scalar' );
 * var ndarray2array = require( './../../../../to-array' );
@@ -237,8 +238,9 @@ interface NullaryStrided1dDispatchConstructor {
 * @returns instance
 *
 * @example
-* var base = require( '@stdlib/blas/ext/base/ndarray/sorthp' );
+* var base = require( '@stdlib/blas/ext/base/ndarray/gsorthp' );
 * var dtypes = require( './../../../../dtypes' );
+* var scalar2ndarray = require( './../../../../from-scalar' );
 * var ndarray2array = require( './../../../../to-array' );
 * var ndarray = require( './../../../../base/ctor' );
 *
@@ -254,7 +256,7 @@ interface NullaryStrided1dDispatchConstructor {
 * var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
 *
 * var order = scalar2ndarray( 1.0, {
-*  'dtype': 'generic'
+* 'dtype': 'generic'
 * });
 *
 * var out = sorthp.assign( x, order );
@@ -278,8 +280,9 @@ interface NullaryStrided1dDispatchConstructor {
 * @returns instance
 *
 * @example
-* var base = require( '@stdlib/blas/ext/base/ndarray/sorthp' );
+* var base = require( '@stdlib/blas/ext/base/ndarray/gsorthp' );
 * var dtypes = require( './../../../../dtypes' );
+* var scalar2ndarray = require( './../../../../from-scalar' );
 * var ndarray2array = require( './../../../../to-array' );
 * var ndarray = require( './../../../../base/ctor' );
 *
@@ -295,7 +298,7 @@ interface NullaryStrided1dDispatchConstructor {
 * var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
 *
 * var order = scalar2ndarray( 1.0, {
-*  'dtype': 'generic'
+* 'dtype': 'generic'
 * });
 *
 * var out = sorthp.assign( x, order );
@@ -320,7 +323,7 @@ interface NullaryStrided1dDispatchConstructor {
 * @returns instance
 *
 * @example
-* var base = require( '@stdlib/blas/ext/base/ndarray/sorthp' );
+* var base = require( '@stdlib/blas/ext/base/ndarray/gsorthp' );
 * var dtypes = require( '@stdlib/ndarray/dtypes' );
 * var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
 * var ndarray2array = require( '@stdlib/ndarray/to-array' );
@@ -341,15 +344,20 @@ interface NullaryStrided1dDispatchConstructor {
 * 'dtype': 'generic'
 * });
 *
-* var y = sorthp.assign( x, order );
+* var out = sorthp.assign( x, order );
 * // returns <ndarray>
 *
-* var arr = ndarray2array( y );
-* // returns [ -1.0, 2.0, 2.0 ]
+* var arr = ndarray2array( x );
+* // returns [ -3.0, -1.0, 2.0 ]
+*
+* var bool = ( out === x );
+* // returns true
 */
 declare var ctor: NullaryStrided1dDispatchConstructor;
 
 
 // EXPORTS //
 
 export = ctor;
+
+// eslint-doctest-alias: NullaryStrided1dDispatch

base/transpose/docs/types/index.d.ts

@@ -32,7 +32,8 @@ import { ndarray, float64ndarray, float32ndarray, int32ndarray, int16ndarray, in
 * var array = require( '@stdlib/ndarray/array' );
 *
 * var x = array( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ], {
-* 'dtype': 'float64'
+* 'dtype': 'float64',
+* 'casting': 'unsafe'
 * });
 * // returns <ndarray>
 *
@@ -63,7 +64,8 @@ declare function transpose( x: float64ndarray ): float64ndarray;
 * var array = require( '@stdlib/ndarray/array' );
 *
 * var x = array( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ], {
-* 'dtype': 'float32'
+* 'dtype': 'float32',
+* 'casting': 'unsafe'
 * });
 * // returns <ndarray>
 *
@@ -150,7 +152,8 @@ declare function transpose( x: complex64ndarray ): complex64ndarray;
 * var array = require( '@stdlib/ndarray/array' );
 *
 * var x = array( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ], {
-* 'dtype': 'int32'
+* 'dtype': 'int32',
+* 'casting': 'unsafe'
 * });
 * // returns <ndarray>
 *
@@ -181,8 +184,9 @@ declare function transpose( x: int32ndarray ): int32ndarray;
 * var array = require( '@stdlib/ndarray/array' );
 *
 * var x = array( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ], {
-* 'dtype': 'int16'
-* });
+* 'dtype': 'int16',
+* 'casting': 'unsafe'
+* });
 * // returns <ndarray>
 *
 * var sh = x.shape;
@@ -212,7 +216,8 @@ declare function transpose( x: int16ndarray ): int16ndarray;
 * var array = require( '@stdlib/ndarray/array' );
 *
 * var x = array( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ], {
-* 'dtype': 'int8'
+* 'dtype': 'int8',
+* 'casting': 'unsafe'
 * });
 * // returns <ndarray>
 *
@@ -243,7 +248,8 @@ declare function transpose( x: int8ndarray ): int8ndarray;
 * var array = require( '@stdlib/ndarray/array' );
 *
 * var x = array( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ], {
-* 'dtype': 'uint32'
+* 'dtype': 'uint32',
+* 'casting': 'unsafe'
 * });
 * // returns <ndarray>
 *
@@ -274,7 +280,8 @@ declare function transpose( x: uint32ndarray ): uint32ndarray;
 * var array = require( '@stdlib/ndarray/array' );
 *
 * var x = array( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ], {
-* 'dtype': 'uint16'
+* 'dtype': 'uint16',
+* 'casting': 'unsafe'
 * });
 * // returns <ndarray>
 *
@@ -305,7 +312,8 @@ declare function transpose( x: uint16ndarray ): uint16ndarray;
 * var array = require( '@stdlib/ndarray/array' );
 *
 * var x = array( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ], {
-* 'dtype': 'uint8'
+* 'dtype': 'uint8',
+* 'casting': 'unsafe'
 * });
 * // returns <ndarray>
 *
@@ -336,7 +344,8 @@ declare function transpose( x: uint8ndarray ): uint8ndarray;
 * var array = require( '@stdlib/ndarray/array' );
 *
 * var x = array( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ], {
-* 'dtype': 'uint8c'
+* 'dtype': 'uint8c',
+* 'casting': 'unsafe'
 * });
 * // returns <ndarray>
 *

base/unary-reduce-subarray-by/docs/types/index.d.ts

@@ -260,7 +260,7 @@ declare function unaryReduceSubarrayBy<T = unknown, U = unknown, V = unknown, W
 * };
 *
 * // Perform a reduction:
-* unaryReduceSubarrayBy( everyBy, [ x, y ], [ 2, 3 ], {}, clbk );
+* unaryReduceSubarrayBy( everyBy, [ x, y ], [ 2, 3 ], clbk );
 *
 * var arr = ndarray2array( y.data, y.shape, y.strides, y.offset, y.order );
 * // returns [ [ true, false, true ] ]

ctor/docs/types/index.d.ts

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

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

@@ -330,7 +330,7 @@ declare function scalar2ndarray( value: boolean, options: BoolOptions ): boolnda
 * @example
 * var x = scalar2ndarray( 1, {
 * 'dtype': 'int32'
-* };
+* });
 * // returns <ndarray>
 *
 * var sh = x.shape;
@@ -353,8 +353,8 @@ declare function scalar2ndarray( value: number, options: Int32Options ): int32nd
 *
 * @example
 * var x = scalar2ndarray( 1, {
-* 'dtype': int16'
-* };
+* 'dtype': 'int16'
+* });
 * // returns <ndarray>
 *
 * var sh = x.shape;
@@ -450,7 +450,7 @@ declare function scalar2ndarray( value: number, options: Uint16Options ): uint16
 * @example
 * var x = scalar2ndarray( 1, {
 * 'dtype': 'uint8'
-* };
+* });
 * // returns <ndarray>
 *
 * var sh = x.shape;
@@ -473,7 +473,7 @@ declare function scalar2ndarray( value: number, options: Uint8Options ): uint8nd
 *
 * @example
 * var x = scalar2ndarray( 1, {
-* 'dtype': uint8c'
+* 'dtype': 'uint8c'
 * });
 * // returns <ndarray>
 *

index/docs/types/index.d.ts

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