Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -22,6 +22,7 @@
 
 <details>
 
+-   [`3116666`](https://github.com/stdlib-js/stdlib/commit/3116666b3e530b2e6fb161924ae4c43cdf02905b) - **docs:** correct TSDoc across `ndarray` TypeScript declarations [(#12635)](https://github.com/stdlib-js/stdlib/pull/12635) _(by Philipp Burckhardt, Athan Reines)_
 -   [`727a69c`](https://github.com/stdlib-js/stdlib/commit/727a69cb34991e322acd1fc76c828a7243faf96f) - **refactor:** remove redundant overload in `ndarray/base/transpose` [(#12632)](https://github.com/stdlib-js/stdlib/pull/12632) _(by Philipp Burckhardt)_
 -   [`853c4b4`](https://github.com/stdlib-js/stdlib/commit/853c4b4f23a7187a6acaf937d9f7af2f079e941d) - **refactor:** remove redundant union member in `ndarray/base/some` [(#12634)](https://github.com/stdlib-js/stdlib/pull/12634) _(by Philipp Burckhardt)_
 -   [`81bb9b4`](https://github.com/stdlib-js/stdlib/commit/81bb9b4388146ac422e75697d177c2beeaf47d41) - **docs:** update `ndarray/iter` TypeScript declarations [(#12592)](https://github.com/stdlib-js/stdlib/pull/12592) _(by stdlib-bot)_
@@ -38,8 +39,9 @@
 
 ### Contributors
 
-A total of 1 person contributed to this release. Thank you to this contributor:
+A total of 2 people contributed to this release. Thank you to the following contributors:
 
+-   Athan Reines
 -   Philipp Burckhardt
 
 </section>

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

@@ -174,7 +174,7 @@ interface AnyBy {
 	<T = unknown, U extends InputArray<T> = InputArray<T>, ThisArg = unknown>( x: U, options: Options, predicate: Predicate<T, U, ThisArg>, thisArg?: ThisParameterType<Predicate<T, U, ThisArg>> ): boolndarray;
 
 	/**
-	* Tests whether at least one element along one or more ndarray dimensions passes a test implemented by a predicate function.
+	* Tests whether at least one element along one or more ndarray dimensions passes a test implemented by a predicate function and assigns the result to a provided output ndarray.
 	*
 	* @param x - input ndarray
 	* @param y - output ndarray
@@ -218,7 +218,7 @@ interface AnyBy {
 	assign<T = unknown, U extends InputArray<T> = InputArray<T>, V extends ndarray = ndarray, ThisArg = unknown>( x: U, y: V, predicate: Predicate<T, U, ThisArg>, thisArg?: ThisParameterType<Predicate<T, U, ThisArg>> ): V;
 
 	/**
-	* Tests whether at least one element along one or more ndarray dimensions passes a test implemented by a predicate function.
+	* Tests whether at least one element along one or more ndarray dimensions passes a test implemented by a predicate function and assigns the result to a provided output ndarray.
 	*
 	* @param x - input ndarray
 	* @param y - output ndarray

array/docs/types/index.d.ts

@@ -144,7 +144,7 @@ interface ExtendedOptions extends Options {
 * @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
@@ -181,7 +181,7 @@ declare function array<T = unknown>( options: OptionsWithShape | OptionsWithBuff
 * @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

base/buffer-dtype-enum/docs/types/index.d.ts

@@ -25,7 +25,7 @@ import { Collection } from '@stdlib/types/array';
 /**
 * 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

base/dtype-str2enum/docs/types/index.d.ts

@@ -19,7 +19,7 @@
 // TypeScript Version: 4.1
 
 /**
-* Returns the enumeration constant associated with a ndarray data type string.
+* Returns the enumeration constant associated with an ndarray data type string.
 *
 * ## Notes
 *

base/from-scalar-like/docs/types/index.d.ts

@@ -88,7 +88,7 @@ declare function scalar2ndarrayLike<T = unknown, U extends InputArray<T> = Input
 * var dt = String( getDType( y ) );
 * // returns 'complex128'
 *
-* var v = y.get();
+* var z = y.get();
 * // returns <Complex128>[ 1.0, 2.0 ]
 */
 declare function scalar2ndarrayLike<T extends typedndarray<ComplexLike> = typedndarray<ComplexLike>>( x: T, value: number ): T;

base/maybe-broadcast-arrays/docs/types/index.d.ts

@@ -28,7 +28,7 @@ import { ndarray } from '@stdlib/types/ndarray';
 *
 * ## 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.

base/next-cartesian-index/docs/types/index.d.ts

@@ -97,7 +97,7 @@ interface Routine {
 	* @param idx - current dimension indices
 	* @param dim - index of the dimension from which to start incrementing (inclusive)
 	* @param out - output array
-	* @returns update dimension indices
+	* @returns updated dimension indices
 	*
 	* @example
 	* var shape = [ 12 ];

base/nullary-strided1d-dispatch-factory/docs/types/index.d.ts

@@ -298,7 +298,7 @@ interface DispatchTable<T, U> extends BaseDispatchTable<T, U> {
 */
 interface NullaryFunction1<T> {
 	/**
-	* Applies a strided function and assign results to a provided output ndarray.
+	* Applies a strided function and assigns results to a provided output ndarray.
 	*
 	* @param out - output ndarray
 	* @param options - function options

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

@@ -28,7 +28,7 @@ import { typedndarray } from '@stdlib/types/ndarray';
 * @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( '@stdlib/ndarray/array' );