Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -4,7 +4,7 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2025-12-05)
+## Unreleased (2025-12-06)
 
 <section class="features">
 
@@ -646,6 +646,7 @@ A total of 36 issues were closed in this release:
 
 <details>
 
+-   [`356e8a0`](https://github.com/stdlib-js/stdlib/commit/356e8a0f15db7f18f8be83272401dc90de4cc1a0) - **docs:** use boolean typed array in example _(by Philipp Burckhardt)_
 -   [`493f0c2`](https://github.com/stdlib-js/stdlib/commit/493f0c2fe4ce47b5ea8e5fedd81ef68d028b83f9) - **feat:** update `ndarray` TypeScript declarations _(by Philipp Burckhardt)_
 -   [`bf3b1ce`](https://github.com/stdlib-js/stdlib/commit/bf3b1ce6e981dc77af2a82a5936ac80b3d029e79) - **docs:** fix TSDoc return annotation _(by Philipp Burckhardt)_
 -   [`53295ce`](https://github.com/stdlib-js/stdlib/commit/53295ce482ae3c95cc80afd5295acbc9f2a476eb) - **feat:** update `ndarray/base` TypeScript declarations _(by Philipp Burckhardt)_

flatten-by/docs/types/index.d.ts

@@ -192,14 +192,14 @@ declare function flattenBy<T extends ComplexLike = ComplexLike, U extends typedn
 * var strides = [ 2, 2, 1 ];
 * var offset = 0;
 *
-* var x = ndarray( 'uint8c', buffer, shape, strides, offset, 'row-major' );
+* var x = ndarray( 'bool', buffer, shape, strides, offset, 'row-major' );
 * // returns <ndarray>
 *
 * var y = flattenBy( x, invert );
 * // returns <ndarray>
 *
 * var arr = ndarray2array( y );
-* // returns [ 0, 1, 0, 1, 0, 1 ]
+* // returns [ false, true, false, true, false, true ]
 */
 declare function flattenBy<T extends typedndarray<boolean> = typedndarray<boolean>, ThisArg = unknown>( x: T, fcn: Callback<boolean, T, boolean, ThisArg>, thisArg?: ThisParameterType<Callback<boolean, T, boolean, ThisArg>> ): T;
 
@@ -340,7 +340,7 @@ declare function flattenBy<T extends ComplexLike = ComplexLike, U extends typedn
 * var strides = [ 2, 2, 1 ];
 * var offset = 0;
 *
-* var x = ndarray( 'uint8c', buffer, shape, strides, offset, 'row-major' );
+* var x = ndarray( 'bool', buffer, shape, strides, offset, 'row-major' );
 * // returns <ndarray>
 *
 * var opts = {
@@ -351,7 +351,7 @@ declare function flattenBy<T extends ComplexLike = ComplexLike, U extends typedn
 * // returns <ndarray>
 *
 * var arr = ndarray2array( y );
-* // returns [ 0, 1, 0, 1, 0, 1 ]
+* // returns [ false, true, false, true, false, true ]
 */
 declare function flattenBy<T extends typedndarray<boolean> = typedndarray<boolean>, ThisArg = unknown>( x: T, options: BaseOptions, fcn: Callback<boolean, T, boolean, ThisArg>, thisArg?: ThisParameterType<Callback<boolean, T, boolean, ThisArg>> ): T;