Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -702,6 +702,7 @@ A total of 40 issues were closed in this release:
 
 <details>
 
+-   [`5149a6b`](https://github.com/stdlib-js/stdlib/commit/5149a6b650b60568bd0df248c2a97a3d8ca2ca87) - **chore:** minor clean-up _(by Philipp Burckhardt)_
 -   [`1aff763`](https://github.com/stdlib-js/stdlib/commit/1aff763c61863b7d737a699db89729d2bba0e1bc) - **feat:** add `ndarray/spread-dimensions` [(#9424)](https://github.com/stdlib-js/stdlib/pull/9424) _(by Muhammad Haris, Athan Reines)_
 -   [`9d53583`](https://github.com/stdlib-js/stdlib/commit/9d53583c9f82e1b2e5dc084849d98bd9c3214d45) - **test:** update descriptions _(by Athan Reines)_
 -   [`3c567b6`](https://github.com/stdlib-js/stdlib/commit/3c567b634cf5e5fa5e31b64f94206db5b4a88133) - **feat:** update `ndarray/base` TypeScript declarations (#9640) [(#9640)](https://github.com/stdlib-js/stdlib/pull/9640) _(by stdlib-bot)_

base/expand-dimensions/README.md

@@ -77,7 +77,7 @@ sh = getShape( y );
 The function accepts the following arguments:
 
 -   **x**: input ndarray.
--   **axis**: axis at which to insert a singleton dimension
+-   **axis**: axis at which to insert a singleton dimension.
 -   **writable**: boolean indicating whether a returned ndarray should be writable.
 
 </section>

find-last/README.md

@@ -71,7 +71,7 @@ The function accepts the following options:
 -   **keepdims**: boolean indicating whether the reduced dimensions should be included in the returned [ndarray][@stdlib/ndarray/ctor] as singleton dimensions. Default: `false`.
 -   **sentinel**: value to return when no element passes the test. May be either a scalar value or a zero-dimensional [ndarray][@stdlib/ndarray/ctor].
 
-By default, the function performs reduction over all all elements in a provided [ndarray][@stdlib/ndarray/ctor]. To reduce specific dimensions, set the `dims` option.
+By default, the function performs reduction over all elements in a provided [ndarray][@stdlib/ndarray/ctor]. To reduce specific dimensions, set the `dims` option.
 
 <!-- eslint-disable max-len -->
 

find-last/docs/types/index.d.ts

@@ -92,6 +92,16 @@ interface Options<T> extends BaseOptions {
 	sentinel?: T | typedndarray<T>;
 }
 
+/**
+* Assign options.
+*/
+interface AssignOptions<T> extends BaseOptions {
+	/**
+	* Sentinel value.
+	*/
+	sentinel?: T | typedndarray<T>;
+}
+
 /**
 * Interface describing `findLast`.
 */
@@ -255,7 +265,7 @@ interface FindLast {
 	* var out = findLast.assign( x, y, {}, isEven );
 	* // returns <ndarray>[ 6.0 ]
 	*/
-	assign<T = unknown, U extends typedndarray<T> = typedndarray<T>, V = T, ThisArg = unknown>( x: ndarray, out: U, options: Options<V>, predicate: Predicate<T, U, ThisArg>, thisArg?: ThisParameterType<Predicate<T, U, ThisArg>> ): U;
+	assign<T = unknown, U extends typedndarray<T> = typedndarray<T>, V = T, ThisArg = unknown>( x: ndarray, out: U, options: AssignOptions<V>, predicate: Predicate<T, U, ThisArg>, thisArg?: ThisParameterType<Predicate<T, U, ThisArg>> ): U;
 }
 
 /**

find-last/lib/assign.js

@@ -37,7 +37,6 @@ var wrap = require( './callback_wrapper.js' );
 * @param {ndarray} out - output ndarray
 * @param {Options} [options] - function options
 * @param {IntegerArray} [options.dims] - list of dimensions over which to perform a reduction
-* @param {boolean} [options.keepdims=false] - boolean indicating whether the reduced dimensions should be included in the returned ndarray as singleton dimensions
 * @param {(*|ndarray)} [options.sentinel] - sentinel value
 * @param {Function} predicate - predicate function
 * @param {*} [thisArg] - predicate function execution context
@@ -84,7 +83,7 @@ function assign( x, out, options, predicate, thisArg ) {
 		throw new TypeError( format( 'invalid argument. First argument must be an ndarray-like object. Value: `%s`.', x ) );
 	}
 	if ( !isndarrayLike( out ) ) {
-		throw new TypeError( format( 'invalid argument. Second argument must be an ndarray-like object. Value: `%s`.', x ) );
+		throw new TypeError( format( 'invalid argument. Second argument must be an ndarray-like object. Value: `%s`.', out ) );
 	}
 	// Case: assign( x, out, predicate )
 	if ( nargs < 4 ) {

find/README.md

@@ -75,7 +75,7 @@ The function accepts the following options:
 -   **keepdims**: boolean indicating whether the reduced dimensions should be included in the returned [ndarray][@stdlib/ndarray/ctor] as singleton dimensions. Default: `false`.
 -   **sentinel**: value to return when no element passes the test. May be either a scalar value or a zero-dimensional [ndarray][@stdlib/ndarray/ctor].
 
-By default, the function performs reduction over all all elements in a provided [ndarray][@stdlib/ndarray/ctor]. To reduce specific dimensions, set the `dims` option.
+By default, the function performs reduction over all elements in a provided [ndarray][@stdlib/ndarray/ctor]. To reduce specific dimensions, set the `dims` option.
 
 ```javascript
 var array = require( '@stdlib/ndarray/array' );

find/docs/types/index.d.ts

@@ -92,6 +92,16 @@ interface Options<T> extends BaseOptions {
 	sentinel?: T | typedndarray<T>;
 }
 
+/**
+* Assign options.
+*/
+interface AssignOptions<T> extends BaseOptions {
+	/**
+	* Sentinel value.
+	*/
+	sentinel?: T | typedndarray<T>;
+}
+
 /**
 * Interface describing `find`.
 */
@@ -261,7 +271,7 @@ interface Find {
 	* var out = find.assign( x, y, {}, isEven );
 	* // returns <ndarray>
 	*/
-	assign<T = unknown, U extends typedndarray<T> = typedndarray<T>, V = T, ThisArg = unknown>( x: ndarray, out: U, options: Options<V>, predicate: Predicate<T, U, ThisArg>, thisArg?: ThisParameterType<Predicate<T, U, ThisArg>> ): U;
+	assign<T = unknown, U extends typedndarray<T> = typedndarray<T>, V = T, ThisArg = unknown>( x: ndarray, out: U, options: AssignOptions<V>, predicate: Predicate<T, U, ThisArg>, thisArg?: ThisParameterType<Predicate<T, U, ThisArg>> ): U;
 }
 
 /**

prepend-singleton-dimensions/docs/repl.txt

@@ -3,6 +3,9 @@
     Returns a read-only view of an input ndarray with a specified number of
     prepended singleton dimensions.
 
+    If `n` is equal to zero, the function returns a read-only view of the input
+    ndarray.
+
     Parameters
     ----------
     x: ndarray

prepend-singleton-dimensions/test/test.js

@@ -101,6 +101,16 @@ tape( 'the function prepends singleton dimensions', function test( t ) {
 	var x;
 	var y;
 
+	x = array( [ [ 1, 2 ], [ 3, 4 ] ] );
+	y = prependSingletonDimensions( x, 0 );
+
+	expected = [ 2, 2 ];
+
+	t.deepEqual( getShape( y ), expected, 'returns expected value' );
+	t.strictEqual( getData( y ), getData( x ), 'returns expected value' );
+	t.notEqual( y, x, 'returns expected value' );
+	t.strictEqual( isReadOnly( y ), true, 'returns expected value' );
+
 	x = array( [ [ 1, 2 ], [ 3, 4 ] ] );
 	y = prependSingletonDimensions( x, 3 );