Auto-generated commit

stdlib-bot · stdlib-bot · commit f13002aa1577 · 2025-06-25T12:30:49.000Z
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,7 +4,7 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2025-06-24)
+## Unreleased (2025-06-25)
 
 <section class="features">
 
@@ -216,6 +216,7 @@ A total of 32 issues were closed in this release:
 
 <details>
 
+-   [`bc3632a`](https://github.com/stdlib-js/stdlib/commit/bc3632a5a7b48a8973b1418e861ddc45b3e8d0fa) - **chore:** minor clean-up _(by Philipp Burckhardt)_
 -   [`b128b6a`](https://github.com/stdlib-js/stdlib/commit/b128b6a25775d9b319c83a9dbb521d8d9c45b8c2) - **chore:** fix ExpectType by supplying correct number of generic parameters _(by Philipp Burckhardt)_
 -   [`4ec1d6d`](https://github.com/stdlib-js/stdlib/commit/4ec1d6d67d746b2231ae18bfaaeb2ee5a9f40697) - **docs:** minor clean-up _(by Philipp Burckhardt)_
 -   [`d3426a4`](https://github.com/stdlib-js/stdlib/commit/d3426a41ee92d8024bf7fc03d200aa98fb62a6f0) - **fix:** use correct dimensions for array _(by Philipp Burckhardt)_
diff --git a/base/fill-by/docs/types/index.d.ts b/base/fill-by/docs/types/index.d.ts
@@ -225,7 +225,7 @@ declare function fillBy<T = unknown, V = unknown, ThisArg = unknown>( x: Accesso
 *
 * var x = [ 1, 2, 3 ];
 *
-* var out = fillBy( x, 4, 0, 3 );
+* var out = fillBy( x, 0, 3, fcn );
 * // returns [ 4, 4, 4 ]
 *
 * @example
@@ -235,7 +235,7 @@ declare function fillBy<T = unknown, V = unknown, ThisArg = unknown>( x: Accesso
 *
 * var x = [ 1, 2, 3, 4, 5, 6 ];
 *
-* var out = fillBy( x, 8, 0, 3 );
+* var out = fillBy( x, 0, 3, fcn );
 * // returns [ 8, 8, 8, 4, 5, 6 ]
 */
 declare function fillBy<T = unknown, V = unknown, ThisArg = unknown>( x: Collection<T>, start: number, end: number, fcn: Callback<T, Collection<T>, V, ThisArg>, thisArg?: ThisParameterType<Callback<T, Collection<T>, V, ThisArg>> ): Collection<T | V>;
diff --git a/base/map5d/docs/types/index.d.ts b/base/map5d/docs/types/index.d.ts
@@ -139,7 +139,7 @@ interface Routine {
 *
 *     -   **value**: array element.
 *     -   **indices**: current array element indices.
-*     --  **array**: input nested array.
+*     -   **array**: input nested array.
 *
 * @param x - input nested array
 * @param shape - array shape
diff --git a/base/mskbinary2d/lib/main.js b/base/mskbinary2d/lib/main.js
@@ -29,7 +29,7 @@
 *
 * @param {ArrayLikeObject<Array<Collection>>} arrays - array-like object containing two input nested arrays, an input nested mask array, and one output nested array
 * @param {NonNegativeIntegerArray} shape - array shape
-* @param {Callback} fcn - unary callback
+* @param {Callback} fcn - binary callback
 * @returns {void}
 *
 * @example
diff --git a/base/mskbinary4d/lib/main.js b/base/mskbinary4d/lib/main.js
@@ -29,7 +29,7 @@
 *
 * @param {ArrayLikeObject<Array<Collection>>} arrays - array-like object containing two input nested arrays, an input nested mask array, and one output nested array
 * @param {NonNegativeIntegerArray} shape - array shape
-* @param {Callback} fcn - unary callback
+* @param {Callback} fcn - binary callback
 * @returns {void}
 *
 * @example
diff --git a/base/mskbinary5d/lib/main.js b/base/mskbinary5d/lib/main.js
@@ -31,7 +31,7 @@
 *
 * @param {ArrayLikeObject<Array<Collection>>} arrays - array-like object containing two input nested arrays, an input nested mask array, and one output nested array
 * @param {NonNegativeIntegerArray} shape - array shape
-* @param {Callback} fcn - unary callback
+* @param {Callback} fcn - binary callback
 * @returns {void}
 *
 * @example
diff --git a/base/put/docs/types/index.d.ts b/base/put/docs/types/index.d.ts
@@ -85,7 +85,7 @@ declare function put<T extends TypedArray | BooleanTypedArray, U = unknown>( x:
 * var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
 *
 * var indices = [ 1, 2 ];
-* var values = new Complex128Array( [ 20.0, 30.0, 40, 5.0 ] );
+* var values = new Complex128Array( [ 20.0, 30.0, 40.0, 5.0 ] );
 *
 * var out = put( x, indices, values, 'throw' );
 * // returns <Complex128Array>
diff --git a/base/unary3d-by/docs/types/index.d.ts b/base/unary3d-by/docs/types/index.d.ts
@@ -104,7 +104,7 @@ type Unary<U, V> = ( value: U ) => V;
 * var x = ones3d( shape );
 * var y = zeros3d( shape );
 *
-* unary3dBy( [ x, y ], shape, scale );
+* unary3dBy( [ x, y ], shape, scale, accessor );
 *
 * console.log( y );
 * // => [ [ [ -10.0, -10.0 ], [ -10.0, -10.0 ] ] ]
diff --git a/nans-like/docs/types/index.d.ts b/nans-like/docs/types/index.d.ts
@@ -259,7 +259,7 @@ declare function nansLike( x: Complex64Array, dtype?: DataType ): Complex64Array
 * // returns [ 0, 0 ]
 *
 * var y = nansLike( x );
-* // returns [ 1, 1 ]
+* // returns [ NaN, NaN ]
 */
 declare function nansLike( x: Array<any>, dtype?: DataType ): Array<number>;
 
diff --git a/shared-buffer/README.md b/shared-buffer/README.md
@@ -110,7 +110,7 @@ try {
 }
 ```
 
-By default, the method copies from the beginning of the [`SharedArrayBuffer`][mdn-sharedarraybuffer]. To beginning copying from a different byte index, provide a `start` argument, specifying the starting byte index (inclusive).
+By default, the method copies from the beginning of the [`SharedArrayBuffer`][mdn-sharedarraybuffer]. To begin copying from a different byte index, provide a `start` argument, specifying the starting byte index (inclusive).
 
 <!-- eslint-disable stdlib/require-globals, no-unused-vars, no-inner-declarations -->
 
diff --git a/struct-factory/lib/main.js b/struct-factory/lib/main.js
@@ -77,7 +77,7 @@ var CTOR_NAME = 'StructArray';
 *     }
 * ];
 *
-* // Create a struct constructor for storing real and imaginary componenets:
+* // Create a struct constructor for storing real and imaginary components:
 * var Components = structFactory( schema1 );
 *
 * var schema2 = [
diff --git a/take/docs/types/index.d.ts b/take/docs/types/index.d.ts
@@ -51,7 +51,7 @@ interface Options {
 *
 * var x = zeroTo( 4, 'float64' );
 * var y = take( x, [ 1, 3 ] );
-* // returns <Float64Array>[ 2.0, 4.0 ]
+* // returns <Float64Array>[ 1.0, 3.0 ]
 */
 declare function take( x: Float64Array, indices: IndexArray, options?: Options ): Float64Array;
 
@@ -68,7 +68,7 @@ declare function take( x: Float64Array, indices: IndexArray, options?: Options )
 *
 * var x = zeroTo( 4, 'float32' );
 * var y = take( x, [ 1, 3 ] );
-* // returns <Float32Array>[ 2.0, 4.0 ]
+* // returns <Float32Array>[ 1.0, 3.0 ]
 */
 declare function take( x: Float32Array, indices: IndexArray, options?: Options ): Float32Array;
 
@@ -85,7 +85,7 @@ declare function take( x: Float32Array, indices: IndexArray, options?: Options )
 *
 * var x = zeroTo( 4, 'int32' );
 * var y = take( x, [ 1, 3 ] );
-* // returns <Int32Array>[ 2, 4 ]
+* // returns <Int32Array>[ 1, 3 ]
 */
 declare function take( x: Int32Array, indices: IndexArray, options?: Options ): Int32Array;
 
@@ -102,7 +102,7 @@ declare function take( x: Int32Array, indices: IndexArray, options?: Options ):
 *
 * var x = zeroTo( 4, 'int16' );
 * var y = take( x, [ 1, 3 ] );
-* // returns <Int16Array>[ 2, 4 ]
+* // returns <Int16Array>[ 1, 3 ]
 */
 declare function take( x: Int16Array, indices: IndexArray, options?: Options ): Int16Array;
 
@@ -119,7 +119,7 @@ declare function take( x: Int16Array, indices: IndexArray, options?: Options ):
 *
 * var x = zeroTo( 4, 'int8' );
 * var y = take( x, [ 1, 3 ] );
-* // returns <Int8Array>[ 2, 4 ]
+* // returns <Int8Array>[ 1, 3 ]
 */
 declare function take( x: Int8Array, indices: IndexArray, options?: Options ): Int8Array;
 
@@ -136,7 +136,7 @@ declare function take( x: Int8Array, indices: IndexArray, options?: Options ): I
 *
 * var x = zeroTo( 4, 'uint32' );
 * var y = take( x, [ 1, 3 ] );
-* // returns <Uint32Array>[ 2, 4 ]
+* // returns <Uint32Array>[ 1, 3 ]
 */
 declare function take( x: Uint32Array, indices: IndexArray, options?: Options ): Uint32Array;
 
@@ -153,7 +153,7 @@ declare function take( x: Uint32Array, indices: IndexArray, options?: Options ):
 *
 * var x = zeroTo( 4, 'uint16' );
 * var y = take( x, [ 1, 3 ] );
-* // returns <Uint16Array>[ 2, 4 ]
+* // returns <Uint16Array>[ 1, 3 ]
 */
 declare function take( x: Uint16Array, indices: IndexArray, options?: Options ): Uint16Array;
 
@@ -170,7 +170,7 @@ declare function take( x: Uint16Array, indices: IndexArray, options?: Options ):
 *
 * var x = zeroTo( 4, 'uint8' );
 * var y = take( x, [ 1, 3 ] );
-* // returns <Uint8Array>[ 2, 4 ]
+* // returns <Uint8Array>[ 1, 3 ]
 */
 declare function take( x: Uint8Array, indices: IndexArray, options?: Options ): Uint8Array;
 
@@ -187,7 +187,7 @@ declare function take( x: Uint8Array, indices: IndexArray, options?: Options ):
 *
 * var x = zeroTo( 4, 'uint8c' );
 * var y = take( x, [ 1, 3 ] );
-* // returns <Uint8ClampedArray>[ 2, 4 ]
+* // returns <Uint8ClampedArray>[ 1, 3 ]
 */
 declare function take( x: Uint8ClampedArray, indices: IndexArray, options?: Options ): Uint8ClampedArray;
 
@@ -204,7 +204,7 @@ declare function take( x: Uint8ClampedArray, indices: IndexArray, options?: Opti
 *
 * var x = zeroTo( 4, 'complex128' );
 * var y = take( x, [ 1, 3 ] );
-* // returns <Complex128Array>[ 2.0, 0.0, 4.0, 0.0 ]
+* // returns <Complex128Array>[ 1.0, 0.0, 3.0, 0.0 ]
 */
 declare function take( x: Complex128Array, indices: IndexArray, options?: Options ): Complex128Array;
 
@@ -221,7 +221,7 @@ declare function take( x: Complex128Array, indices: IndexArray, options?: Option
 *
 * var x = zeroTo( 4, 'complex64' );
 * var y = take( x, [ 1, 3 ] );
-* // returns <Complex64Array>[ 2.0, 0.0, 4.0, 0.0 ]
+* // returns <Complex64Array>[ 1.0, 0.0, 3.0, 0.0 ]
 */
 declare function take( x: Complex64Array, indices: IndexArray, options?: Options ): Complex64Array;
 
diff --git a/to-sparse-iterator-right/README.md b/to-sparse-iterator-right/README.md
@@ -168,8 +168,6 @@ var count = ctx.count;
 <!-- eslint no-undef: "error" -->
 
 ```javascript
-var Float64Array = require( '@stdlib/array/float64' );
-var inmap = require( '@stdlib/utils/inmap' );
 var randu = require( '@stdlib/random/base/randu' );
 var sparsearray2iteratorRight = require( '@stdlib/array/to-sparse-iterator-right' );
 
diff --git a/to-sparse-iterator/README.md b/to-sparse-iterator/README.md
@@ -168,8 +168,6 @@ var count = ctx.count;
 <!-- eslint no-undef: "error" -->
 
 ```javascript
-var Float64Array = require( '@stdlib/array/float64' );
-var inmap = require( '@stdlib/utils/inmap' );
 var randu = require( '@stdlib/random/base/randu' );
 var sparsearray2iterator = require( '@stdlib/array/to-sparse-iterator' );
 
diff --git a/uint8c/docs/repl.txt b/uint8c/docs/repl.txt
@@ -355,7 +355,7 @@
     The returned array has the same data type as the host array.
 
     If a predicate function does not return a truthy value for any array
-    element, the method returns `null`.
+    element, the method returns an empty array.
 
     Parameters
     ----------
@@ -761,7 +761,7 @@
     the host array.
 
     If the method is unable to resolve indices to a non-empty array subsequence,
-    the method returns `null`.
+    the method returns an empty array.
 
     Parameters
     ----------
@@ -804,7 +804,7 @@
     ----------
     predicate: Function
         Predicate function which tests array elements. If a predicate function
-        returns a truthy value, a array element passes; otherwise, an array
+        returns a truthy value, an array element passes; otherwise, an array
         element fails.
 
     thisArg: Any (optional)

Original file line number	Diff line number	Diff line change
`@@ -225,7 +225,7 @@ declare function fillBy<T = unknown, V = unknown, ThisArg = unknown>( x: Accesso`
`225`	`225`	`*`
`226`	`226`	`* var x = [ 1, 2, 3 ];`
`227`	`227`	`*`
`228`		`-* var out = fillBy( x, 4, 0, 3 );`
	`228`	`+* var out = fillBy( x, 0, 3, fcn );`
`229`	`229`	`* // returns [ 4, 4, 4 ]`
`230`	`230`	`*`
`231`	`231`	`* @example`
`@@ -235,7 +235,7 @@ declare function fillBy<T = unknown, V = unknown, ThisArg = unknown>( x: Accesso`
`235`	`235`	`*`
`236`	`236`	`* var x = [ 1, 2, 3, 4, 5, 6 ];`
`237`	`237`	`*`
`238`		`-* var out = fillBy( x, 8, 0, 3 );`
	`238`	`+* var out = fillBy( x, 0, 3, fcn );`
`239`	`239`	`* // returns [ 8, 8, 8, 4, 5, 6 ]`
`240`	`240`	`*/`
`241`	`241`	`declare function fillBy<T = unknown, V = unknown, ThisArg = unknown>( x: Collection<T>, start: number, end: number, fcn: Callback<T, Collection<T>, V, ThisArg>, thisArg?: ThisParameterType<Callback<T, Collection<T>, V, ThisArg>> ): Collection<T \| V>;`
Original file line number	Diff line number	Diff line change
`@@ -139,7 +139,7 @@ interface Routine {`
`139`	`139`	`*`
`140`	`140`	`* - value: array element.`
`141`	`141`	`* - indices: current array element indices.`
`142`		`-* -- array: input nested array.`
	`142`	`+* - array: input nested array.`
`143`	`143`	`*`
`144`	`144`	`* @param x - input nested array`
`145`	`145`	`* @param shape - array shape`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@`
`29`	`29`	`*`
`30`	`30`	`* @param {ArrayLikeObject<Array<Collection>>} arrays - array-like object containing two input nested arrays, an input nested mask array, and one output nested array`
`31`	`31`	`* @param {NonNegativeIntegerArray} shape - array shape`
`32`		`-* @param {Callback} fcn - unary callback`
	`32`	`+* @param {Callback} fcn - binary callback`
`33`	`33`	`* @returns {void}`
`34`	`34`	`*`
`35`	`35`	`* @example`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@`
`31`	`31`	`*`
`32`	`32`	`* @param {ArrayLikeObject<Array<Collection>>} arrays - array-like object containing two input nested arrays, an input nested mask array, and one output nested array`
`33`	`33`	`* @param {NonNegativeIntegerArray} shape - array shape`
`34`		`-* @param {Callback} fcn - unary callback`
	`34`	`+* @param {Callback} fcn - binary callback`
`35`	`35`	`* @returns {void}`
`36`	`36`	`*`
`37`	`37`	`* @example`
Original file line number	Diff line number	Diff line change
`@@ -85,7 +85,7 @@ declare function put<T extends TypedArray \| BooleanTypedArray, U = unknown>( x:`
`85`	`85`	`* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );`
`86`	`86`	`*`
`87`	`87`	`* var indices = [ 1, 2 ];`
`88`		`-* var values = new Complex128Array( [ 20.0, 30.0, 40, 5.0 ] );`
	`88`	`+* var values = new Complex128Array( [ 20.0, 30.0, 40.0, 5.0 ] );`
`89`	`89`	`*`
`90`	`90`	`* var out = put( x, indices, values, 'throw' );`
`91`	`91`	`* // returns <Complex128Array>`
Original file line number	Diff line number	Diff line change
`@@ -104,7 +104,7 @@ type Unary<U, V> = ( value: U ) => V;`
`104`	`104`	`* var x = ones3d( shape );`
`105`	`105`	`* var y = zeros3d( shape );`
`106`	`106`	`*`
`107`		`-* unary3dBy( [ x, y ], shape, scale );`
	`107`	`+* unary3dBy( [ x, y ], shape, scale, accessor );`
`108`	`108`	`*`
`109`	`109`	`* console.log( y );`
`110`	`110`	`* // => [ [ [ -10.0, -10.0 ], [ -10.0, -10.0 ] ] ]`
Original file line number	Diff line number	Diff line change
`@@ -259,7 +259,7 @@ declare function nansLike( x: Complex64Array, dtype?: DataType ): Complex64Array`
`259`	`259`	`* // returns [ 0, 0 ]`
`260`	`260`	`*`
`261`	`261`	`* var y = nansLike( x );`
`262`		`-* // returns [ 1, 1 ]`
	`262`	`+* // returns [ NaN, NaN ]`
`263`	`263`	`*/`
`264`	`264`	`declare function nansLike( x: Array<any>, dtype?: DataType ): Array<number>;`
`265`	`265`
Original file line number	Diff line number	Diff line change
`@@ -110,7 +110,7 @@ try {`
`110`	`110`	`}`
`111`	`111`	```
`112`	`112`
`113`		-By default, the method copies from the beginning of the [`SharedArrayBuffer`][mdn-sharedarraybuffer]. To beginning copying from a different byte index, provide a `start` argument, specifying the starting byte index (inclusive).
	`113`	+By default, the method copies from the beginning of the [`SharedArrayBuffer`][mdn-sharedarraybuffer]. To begin copying from a different byte index, provide a `start` argument, specifying the starting byte index (inclusive).
`114`	`114`
`115`	`115`	`<!-- eslint-disable stdlib/require-globals, no-unused-vars, no-inner-declarations -->`
`116`	`116`