Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -4,12 +4,13 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2025-11-21)
+## Unreleased (2025-11-26)
 
 <section class="features">
 
 ### Features
 
+-   [`f1fbeb4`](https://github.com/stdlib-js/stdlib/commit/f1fbeb47d9a2a6672bc9690b0b006534168e904a) - add `ndarray/fliplr` [(#8589)](https://github.com/stdlib-js/stdlib/pull/8589)
 -   [`a2fd4d6`](https://github.com/stdlib-js/stdlib/commit/a2fd4d6929c7af4f33ebe97d53fec4b7a9bcbf33) - add `ndarray/some` [(#8514)](https://github.com/stdlib-js/stdlib/pull/8514)
 -   [`4b6f051`](https://github.com/stdlib-js/stdlib/commit/4b6f0510d4773574101122924f20cb4d987c2b38) - add `complementShape` to namespace
 -   [`903f141`](https://github.com/stdlib-js/stdlib/commit/903f1415351afbabd33b859b0888ad2daa02ecc0) - add `ndarray/base/complement-shape`
@@ -641,6 +642,11 @@ A total of 34 issues were closed in this release:
 
 <details>
 
+-   [`f1fbeb4`](https://github.com/stdlib-js/stdlib/commit/f1fbeb47d9a2a6672bc9690b0b006534168e904a) - **feat:** add `ndarray/fliplr` [(#8589)](https://github.com/stdlib-js/stdlib/pull/8589) _(by Muhammad Haris)_
+-   [`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)_
 -   [`f870646`](https://github.com/stdlib-js/stdlib/commit/f870646312fdbc9c2fb63bcfa7094cf889ed75f1) - **test:** add tests to `ndarray/base/count-truthy` [(#8301)](https://github.com/stdlib-js/stdlib/pull/8301) _(by Muhammad Haris, Athan Reines)_
 -   [`555d6f3`](https://github.com/stdlib-js/stdlib/commit/555d6f3a7931b2c898fc8a6474ba81879f56d4d3) - **test:** add tests to `ndarray/base/count-falsy` [(#8305)](https://github.com/stdlib-js/stdlib/pull/8305) _(by Muhammad Haris, Athan Reines)_
 -   [`ce0bfa5`](https://github.com/stdlib-js/stdlib/commit/ce0bfa50e43dc1f8ee15679b6194c1349730de59) - **test:** fix underlying buffer type _(by Athan Reines)_

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

@@ -424,7 +424,7 @@ declare function scalar2ndarrayLike<T = unknown>( x: genericndarray<T>, value: T
 * // returns []
 *
 * var dt = y.dtype;
-* // returns 'generic'
+* // returns 'float64'
 *
 * var v = y.get();
 * // returns 1.0

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

@@ -55,7 +55,7 @@ import { ndarray } from '@stdlib/types/ndarray';
 * });
 *
 * // Perform reduction:
-* var out = includes( [ x, searchElement ] );
+* var out = includes( [ x, v ] );
 * // returns true
 */
 declare function includes( arrays: ArrayLike<ndarray> ): boolean;

base/loop-interchange-order/docs/types/index.d.ts

@@ -57,8 +57,8 @@ import { ArrayLike } from '@stdlib/types/array';
 * var sy = [ 24, 8, 1 ]; // row-major
 * var sz = [ 1, -2, 6 ]; // column-major
 *
-* var o = loopOrder( shape, [ sx, sy, sz ] );
-* // returns {...}
+* var o = loopOrder( sh, [ sx, sy, sz ] );
+* // returns [...]
 *
 * var ssh = o[ 0 ];
 * // returns [ 4, 3, 2 ]

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

@@ -53,8 +53,8 @@ import { ndarray } from '@stdlib/types/ndarray';
 * var shy = y1.shape;
 * // returns [ 3, 2, 2 ]
 *
-* var out = maybeBroadcastArrays( [ x, y ] );
-* // returns <ndarray>
+* var out = maybeBroadcastArrays( [ x, y1 ] );
+* // returns [ <ndarray>, <ndarray> ]
 *
 * var x2 = out[ 0 ];
 * // returns <ndarray>

base/unary-reduce-strided1d-dispatch-by-factory/docs/types/index.d.ts

@@ -234,7 +234,7 @@ interface UnaryFunction<T, U> {
 	* // returns <ndarray>
 	*
 	* var v = y.get();
-	* // returns 2.0
+	* // returns 4.0
 	*/
 	<ThisArg = unknown>( x: InputArray<T>, ...args: Array<InputArray<T> | Options | Callback<T, U, ThisArg> | ThisParameterType<Callback<T, U, ThisArg>>> ): OutputArray<U>; // NOTE: we lose type specificity here, but retaining specificity would likely be difficult and/or tedious to completely enumerate, as the output ndarray data type is dependent on how `x` interacts with output data type policy and whether that policy has been overridden by `options.dtype`. In principle, as well, based on the policy, it is possible to know more exactly which `InputArray` types are actually allowed.
 
@@ -278,7 +278,7 @@ interface UnaryFunction<T, U> {
 	* // returns <ndarray>
 	*
 	* var v = out.get();
-	* // returns 2.0
+	* // returns 4.0
 	*
 	* var bool = ( out === y );
 	* // returns true
@@ -326,7 +326,7 @@ interface UnaryFunction<T, U> {
 	* // returns <ndarray>
 	*
 	* var v = out.get();
-	* // returns 2.0
+	* // returns 4.0
 	*
 	* var bool = ( out === y );
 	* // returns true
@@ -374,7 +374,7 @@ interface UnaryFunction<T, U> {
 	* // returns <ndarray>
 	*
 	* var v = out.get();
-	* // returns 2.0
+	* // returns 4.0
 	*
 	* var bool = ( out === y );
 	* // returns true
@@ -419,7 +419,7 @@ interface UnaryFunction<T, U> {
 * // returns <ndarray>
 *
 * var v = y.get();
-* // returns 2.0
+* // returns 4.0
 */
 declare function factory<T = unknown, U = unknown>( table: DispatchTable<T, U> | BaseDispatchTable<T, U>, idtypes: ArrayLike<ArrayLike<DataType>>, odtypes: ArrayLike<DataType>, policies: Policies ): UnaryFunction<T, U>;
 

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

@@ -551,6 +551,7 @@ interface UnaryStrided1dDispatchByConstructor {
 */
 declare var ctor: UnaryStrided1dDispatchByConstructor;
 
+// eslint-doctest-alias: UnaryStrided1dDispatchBy
 
 // EXPORTS //
 

base/unary-reduce-strided1d-dispatch/docs/types/index.d.ts

@@ -393,6 +393,8 @@ interface UnaryStrided1dDispatchConstructor {
 */
 declare var ctor: UnaryStrided1dDispatchConstructor;
 
+// eslint-doctest-alias: UnaryStrided1dDispatch
+
 
 // EXPORTS //
 

base/unary-strided1d-dispatch-factory/docs/types/index.d.ts

@@ -148,7 +148,7 @@ interface UnaryFunction<T, U> {
 	* var table = {
 	*     'default': base
 	* };
-	* var cumax = factory( table, [ idt ], odt, policy );
+	* var cumax = factory( table, [ idt ], odt, policies );
 	*
 	* var xbuf = [ -1.0, 2.0, -3.0 ];
 	* var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
@@ -185,7 +185,7 @@ interface UnaryFunction<T, U> {
 	* var table = {
 	*     'default': base
 	* };
-	* var cumax = factory( table, [ idt ], odt, policy );
+	* var cumax = factory( table, [ idt ], odt, policies );
 	*
 	* var xbuf = [ -1.0, 2.0, -3.0 ];
 	* var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
@@ -228,7 +228,7 @@ interface UnaryFunction<T, U> {
 	* var table = {
 	*     'default': base
 	* };
-	* var cumax = factory( table, [ idt ], odt, policy );
+	* var cumax = factory( table, [ idt ], odt, policies );
 	*
 	* var xbuf = [ -1.0, 2.0, -3.0 ];
 	* var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
@@ -274,7 +274,7 @@ interface UnaryFunction<T, U> {
 * var table = {
 *     'default': base
 * };
-* var cumax = factory( table, [ idt ], odt, policy );
+* var cumax = factory( table, [ idt ], odt, policies );
 *
 * var xbuf = [ -1.0, 2.0, -3.0 ];
 * var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );

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

@@ -409,6 +409,8 @@ interface UnaryStrided1dDispatchConstructor {
 */
 declare var ctor: UnaryStrided1dDispatchConstructor;
 
+// eslint-doctest-alias: UnaryStrided1dDispatch
+
 
 // EXPORTS //