Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -33,6 +33,9 @@
 
 <details>
 
+-   [`a9e03ed`](https://github.com/stdlib-js/stdlib/commit/a9e03edc48bf43a1c290ed1ec1e2f69186678b15) - **refactor:** add missing generic type-parameter defaults in `ndarray` reverse declarations [(#12666)](https://github.com/stdlib-js/stdlib/pull/12666) _(by Philipp Burckhardt)_
+-   [`d01cc15`](https://github.com/stdlib-js/stdlib/commit/d01cc150c5d271c5132af9706f86fd15160e5f39) - **docs:** update `ndarray` TypeScript declarations [(#12662)](https://github.com/stdlib-js/stdlib/pull/12662) _(by stdlib-bot)_
+-   [`69a4924`](https://github.com/stdlib-js/stdlib/commit/69a49243032c5e1a845cba2f895c835a49368b77) - **docs:** update `ndarray/iter` TypeScript declarations [(#12661)](https://github.com/stdlib-js/stdlib/pull/12661) _(by stdlib-bot)_
 -   [`02ceb9e`](https://github.com/stdlib-js/stdlib/commit/02ceb9ef7c4b0b987a79f07daa750ea9c18f3159) - **docs:** update `ndarray/base` TypeScript declarations [(#12660)](https://github.com/stdlib-js/stdlib/pull/12660) _(by stdlib-bot)_
 -   [`cd863cf`](https://github.com/stdlib-js/stdlib/commit/cd863cfcc93259fc77714263c6c8b532c84563a3) - **docs:** propagate recent develop fixes to sibling packages [(#12642)](https://github.com/stdlib-js/stdlib/pull/12642) _(by Philipp Burckhardt)_
 -   [`4e89875`](https://github.com/stdlib-js/stdlib/commit/4e898755cf98f6e3b8d8c24079fb9ea7730f2d9c) - **fix:** preserve input ndarray type in `ndarray/base/maybe-broadcast-array-except-dimensions` [(#12629)](https://github.com/stdlib-js/stdlib/pull/12629) _(by Philipp Burckhardt, Athan Reines)_

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

@@ -51,7 +51,7 @@ import { ndarray } from '@stdlib/types/ndarray';
 * sh = getShape( y );
 * // returns [ 3, 2 ]
 */
-declare function reverse<T extends ndarray>( x: T, writable: boolean ): T;
+declare function reverse<T extends ndarray = ndarray>( x: T, writable: boolean ): T;
 
 
 // EXPORTS //

docs/types/index.d.ts

@@ -310,7 +310,7 @@ interface Namespace {
 	* @param options.flatten - boolean indicating whether to automatically flatten generic array data sources (default: true)
 	* @param options.ndmin - minimum number of dimensions (default: 0)
 	* @param options.casting - casting rule used to determine what constitutes an acceptable cast (default: 'safe')
-	* @param options.readonly - boolean indicating whether an array should be read-only
+	* @param options.readonly - boolean indicating whether an array should be read-only (default: false)
 	* @throws must provide valid options
 	* @throws must provide either an array shape, data source, or both
 	* @throws invalid cast
@@ -680,7 +680,6 @@ interface Namespace {
 	*
 	* @example
 	* var array = require( './../../array' );
-	* var ndarray2array = require( './../../to-array' );
 	*
 	* var x = array( [ -1.0, 2.0, 3.0, 4.0 ] );
 	* var y = array( [ -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ] );
@@ -691,7 +690,6 @@ interface Namespace {
 	* @example
 	* var array = require( './../../array' );
 	* var empty = require( './../../empty' );
-	* var ndarray2array = require( './../../to-array' );
 	*
 	* var x = array( [ -1.0, 2.0, 3.0, 4.0 ] );
 	* var y = array( [ -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ] );
@@ -2413,7 +2411,7 @@ interface Namespace {
 	*
 	* ## Notes
 	*
-	* -   The function throws an error if a provided broadcast-incompatible ndarrays.
+	* -   The function throws an error if provided broadcast-incompatible ndarrays.
 	* -   If a provided ndarray has a shape matching the common shape, the function returns the provided ndarray.
 	* -   If a provided ndarray has a different (broadcast compatible) shape than the common shape, the function returns a new **read-only** ndarray view of the provided ndarray's data. The view is typically **not** contiguous. As more than one element of a returned view may refer to the same memory location, writing to a view may affect multiple elements. If you need to write to an input array, copy the array before broadcasting.
 	*

iter/docs/types/index.d.ts

@@ -188,7 +188,7 @@ interface Namespace {
 	*
 	* ## Notes
 	*
-	* -   The function throws an error if a provided broadcast-incompatible ndarrays.
+	* -   The function throws an error if provided broadcast-incompatible ndarrays.
 	* -   For input ndarrays supporting read-only views, the function returns *read-only* views of interleaved subarrays. As input ndarrays may be broadcasted, a view is typically *not* contiguous. As more than one element of a returned view may refer to the same memory location, writing to a view may affect multiple elements. If you need to write to a subarray, copy the subarray before attempting mutation.
 	*
 	* @param arr - input ndarrays

to-reversed-dimension/docs/types/index.d.ts

@@ -38,7 +38,7 @@ interface Options {
 * @param x - input array
 * @param options - function options
 * @param options.dim - index of dimension to reverse
-* @returns output array
+* @returns output ndarray
 *
 * @example
 * var array = require( '@stdlib/ndarray/array' );
@@ -49,7 +49,7 @@ interface Options {
 * var y = toReversedDimension( x );
 * // returns <ndarray>[ [ 2.0, 1.0 ], [ 4.0, 3.0 ] ]
 */
-declare function toReversedDimension<T extends ndarray>( x: T, options?: Options ): T;
+declare function toReversedDimension<T extends ndarray = ndarray>( x: T, options?: Options ): T;
 
 
 // EXPORTS //