Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -33,6 +33,9 @@
 
 <details>
 
+-   [`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)_
 -   [`95016b8`](https://github.com/stdlib-js/stdlib/commit/95016b8c7179f978fb8ef5b272cff36b523e06e6) - **fix:** add missing import in `ndarray/base/unflatten` declarations [(#12625)](https://github.com/stdlib-js/stdlib/pull/12625) _(by Philipp Burckhardt, Athan Reines)_

base/docs/types/index.d.ts

@@ -1154,7 +1154,7 @@ interface Namespace {
 	/**
 	* Returns the data type enumeration constant for a provided ndarray data buffer.
 	*
-	* @param arr - strided array
+	* @param arr - ndarray data buffer
 	* @returns data type enumeration constant or null
 	*
 	* @example
@@ -1645,7 +1645,7 @@ interface Namespace {
 	dtypeResolveStr: typeof dtypeResolveStr;
 
 	/**
-	* Returns the enumeration constant associated with a ndarray data type string.
+	* Returns the enumeration constant associated with an ndarray data type string.
 	*
 	* ## Notes
 	*
@@ -2373,7 +2373,7 @@ interface Namespace {
 	* var dt = String( getDType( y ) );
 	* // returns 'complex128'
 	*
-	* var v = y.get();
+	* var z = y.get();
 	* // returns <Complex128>[ 1.0, 2.0 ]
 	*/
 	scalar2ndarrayLike: typeof scalar2ndarrayLike;
@@ -2818,7 +2818,7 @@ interface Namespace {
 	maybeBroadcastArray: typeof maybeBroadcastArray;
 
 	/**
-	* Broadcasts an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape.
+	* Broadcasts an ndarray to a specified shape while keeping a list of specified dimensions unchanged if and only if the specified shape differs from the provided ndarray's shape.
 	*
 	* ## Notes
 	*
@@ -2854,7 +2854,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 (base) 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 a returned array, copy the array before performing operations which may mutate elements.
 	* -   A returned array view is a "base" ndarray, and, thus, a returned array view does not perform bounds checking or afford any of the guarantees of the non-base ndarray constructor. The primary intent of this function is to broadcast ndarray-like objects within internal implementations and to do so with minimal overhead.
@@ -4246,7 +4246,7 @@ interface Namespace {
 	* @param x - input array
 	* @param k - number of times to rotate by 90 degrees
 	* @param writable - boolean indicating whether the returned ndarray should be writable
-	* @returns output array
+	* @returns ndarray view
 	*
 	* @example
 	* var array = require( './../../../array' );
@@ -4285,7 +4285,7 @@ interface Namespace {
 	*         <order>[int8],
 	*         <mode>[int8],
 	*         <nsubmodes>[int64],
-	*         <submodes>[nsubmodes*int8]
+	*         <submodes>[nsubmodes*int8],
 	*         <flags>[int32]
 	*     ]
 	*     ```

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