Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -61,6 +61,7 @@
 
 <details>
 
+-   [`7dc9808`](https://github.com/stdlib-js/stdlib/commit/7dc98086e9503556dc548aa2e4899f299c12999f) - **docs:** fix examples, notes, and return description [(#13151)](https://github.com/stdlib-js/stdlib/pull/13151) _(by Philipp Burckhardt)_
 -   [`d5f4058`](https://github.com/stdlib-js/stdlib/commit/d5f40586d65278965d4e3c98b774ca7505a92e0a) - **docs:** update option description [(#13145)](https://github.com/stdlib-js/stdlib/pull/13145) _(by stdlib-bot)_
 -   [`7ff0456`](https://github.com/stdlib-js/stdlib/commit/7ff0456ac62f36e058b8f25bd3628750ab3daf7f) - **docs:** document accepted arguments _(by Athan Reines)_
 -   [`56ffe96`](https://github.com/stdlib-js/stdlib/commit/56ffe96cd1f83bb3e66cc0c2b63eba05fd2d5ee9) - **docs:** document accepted arguments _(by Athan Reines)_

matrix/complex128/README.md

@@ -118,7 +118,7 @@ var sh = getShape( arr );
 
 The function accepts the following arguments:
 
--   **obj**: array-like object or iterable from which to generate an [ndarray][@stdlib/ndarray/ctor]. If an array-like object, the value must be a nested array (i.e., an array-like object of array-like objects), where each nested array must have the same number of elements. If an iterable, the iterable must return array- like objects, each of which must have the same number of elements.
+-   **obj**: array-like object or iterable from which to generate an [ndarray][@stdlib/ndarray/ctor]. If an array-like object, the value must be a nested array (i.e., an array-like object of array-like objects), where each nested array must have the same number of elements. If an iterable, the iterable must return array-like objects, each of which must have the same number of elements.
 -   **options**: function options. See above.
 
 #### Complex128Matrix( buffer\[, byteOffset\[, shape]]\[, options] )

matrix/complex128/docs/types/index.d.ts

@@ -443,7 +443,7 @@ interface Complex128Matrix {
 	* var ArrayBuffer = require( '@stdlib/array/buffer' );
 	*
 	* var buf = new ArrayBuffer( 64 );
-	* var arr = new Complex128Matrix( buf, 16, [ 2, 1 ] );
+	* var arr = new Complex128Matrix( buf, 16, 2, 1 );
 	* // returns <ndarray>
 	*
 	* var sh = getShape( arr );

matrix/complex64/README.md

@@ -118,7 +118,7 @@ var sh = getShape( arr );
 
 The function accepts the following arguments:
 
--   **obj**: array-like object or iterable from which to generate an [ndarray][@stdlib/ndarray/ctor]. If an array-like object, the value must be a nested array (i.e., an array-like object of array-like objects), where each nested array must have the same number of elements. If an iterable, the iterable must return array- like objects, each of which must have the same number of elements.
+-   **obj**: array-like object or iterable from which to generate an [ndarray][@stdlib/ndarray/ctor]. If an array-like object, the value must be a nested array (i.e., an array-like object of array-like objects), where each nested array must have the same number of elements. If an iterable, the iterable must return array-like objects, each of which must have the same number of elements.
 -   **options**: function options. See above.
 
 #### Complex64Matrix( buffer\[, byteOffset\[, shape]]\[, options] )

matrix/complex64/docs/types/index.d.ts

@@ -443,7 +443,7 @@ interface Complex64Matrix {
 	* var ArrayBuffer = require( '@stdlib/array/buffer' );
 	*
 	* var buf = new ArrayBuffer( 64 );
-	* var arr = new Complex64Matrix( buf, 16, [ 2, 1 ] );
+	* var arr = new Complex64Matrix( buf, 16, 2, 1 );
 	* // returns <ndarray>
 	*
 	* var sh = getShape( arr );

matrix/ctor/README.md

@@ -161,7 +161,7 @@ var sh2 = getShape( arr2 );
 
 The function accepts the following arguments:
 
--   **obj**: array-like object or iterable from which to generate an [ndarray][@stdlib/ndarray/ctor]. If an array-like object, the value must be a nested array (i.e., an array-like object of array-like objects), where each nested array must have the same number of elements. If an iterable, the iterable must return array- like objects, each of which must have the same number of elements.
+-   **obj**: array-like object or iterable from which to generate an [ndarray][@stdlib/ndarray/ctor]. If an array-like object, the value must be a nested array (i.e., an array-like object of array-like objects), where each nested array must have the same number of elements. If an iterable, the iterable must return array-like objects, each of which must have the same number of elements.
 -   **dtype**: [data type][@stdlib/ndarray/dtypes].
 -   **options**: function options. See above.
 

matrix/float32/README.md

@@ -116,7 +116,7 @@ var sh = getShape( arr );
 
 The function accepts the following arguments:
 
--   **obj**: array-like object or iterable from which to generate an [ndarray][@stdlib/ndarray/ctor]. If an array-like object, the value must be a nested array (i.e., an array-like object of array-like objects), where each nested array must have the same number of elements. If an iterable, the iterable must return array- like objects, each of which must have the same number of elements.
+-   **obj**: array-like object or iterable from which to generate an [ndarray][@stdlib/ndarray/ctor]. If an array-like object, the value must be a nested array (i.e., an array-like object of array-like objects), where each nested array must have the same number of elements. If an iterable, the iterable must return array-like objects, each of which must have the same number of elements.
 -   **options**: function options. See above.
 
 #### Float32Matrix( buffer\[, byteOffset\[, shape]]\[, options] )

matrix/float32/docs/types/index.d.ts

@@ -443,7 +443,7 @@ interface Float32Matrix {
 	* var ArrayBuffer = require( '@stdlib/array/buffer' );
 	*
 	* var buf = new ArrayBuffer( 32 );
-	* var arr = new Float32Matrix( buf, 8, [ 2, 1 ] );
+	* var arr = new Float32Matrix( buf, 8, 2, 1 );
 	* // returns <ndarray>
 	*
 	* var sh = getShape( arr );

matrix/float64/README.md

@@ -116,7 +116,7 @@ var sh = getShape( arr );
 
 The function accepts the following arguments:
 
--   **obj**: array-like object or iterable from which to generate an [ndarray][@stdlib/ndarray/ctor]. If an array-like object, the value must be a nested array (i.e., an array-like object of array-like objects), where each nested array must have the same number of elements. If an iterable, the iterable must return array- like objects, each of which must have the same number of elements.
+-   **obj**: array-like object or iterable from which to generate an [ndarray][@stdlib/ndarray/ctor]. If an array-like object, the value must be a nested array (i.e., an array-like object of array-like objects), where each nested array must have the same number of elements. If an iterable, the iterable must return array-like objects, each of which must have the same number of elements.
 -   **options**: function options. See above.
 
 #### Float64Matrix( buffer\[, byteOffset\[, shape]]\[, options] )

matrix/float64/docs/types/index.d.ts

@@ -443,7 +443,7 @@ interface Float64Matrix {
 	* var ArrayBuffer = require( '@stdlib/array/buffer' );
 	*
 	* var buf = new ArrayBuffer( 32 );
-	* var arr = new Float64Matrix( buf, 8, [ 2, 1 ] );
+	* var arr = new Float64Matrix( buf, 8, 2, 1 );
 	* // returns <ndarray>
 	*
 	* var sh = getShape( arr );