Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -737,6 +737,7 @@ A total of 43 issues were closed in this release:
 
 <details>
 
+-   [`805412f`](https://github.com/stdlib-js/stdlib/commit/805412fecd7227470a7fb28606c94f00d1e7538e) - **docs:** update `ndarray/base` TypeScript declarations [(#10021)](https://github.com/stdlib-js/stdlib/pull/10021) _(by stdlib-bot)_
 -   [`9696b4d`](https://github.com/stdlib-js/stdlib/commit/9696b4d2af500640e8fdd5f76a499248e3f2f17a) - **docs:** update namespace table of contents [(#10022)](https://github.com/stdlib-js/stdlib/pull/10022) _(by stdlib-bot)_
 -   [`7b69002`](https://github.com/stdlib-js/stdlib/commit/7b69002e03bd424815f80e156e0994f150e80175) - **feat:** ensure support for non-string dtypes and update tests to use functional accessors _(by Athan Reines)_
 -   [`4794f9e`](https://github.com/stdlib-js/stdlib/commit/4794f9e933b2f3375daa7d74d856dd8af79ce5ea) - **test:** use functional accessors and ensure support for non-string dtypes _(by Athan Reines)_

base/docs/types/index.d.ts

@@ -1859,30 +1859,23 @@ interface Namespace {
 	* var typedarray = require( '@stdlib/array/typed' );
 	* var ndarray = require( './../../../ctor' );
 	* var getShape = require( './../../../shape' );
-	* var ndarray2array = require( './../../../to-array' );
 	*
-	* var buffer = [ 1, 2, 3, 4, 5, 6 ];
+	* var buffer = typedarray( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ], 'float64' );
 	* var shape = [ 3, 2 ];
 	* var strides = [ 2, 1 ];
 	* var offset = 0;
 	*
-	* var x = ndarray( 'generic', buffer, shape, strides, offset, 'row-major' );
-	* // returns <ndarray>
+	* var x = ndarray( 'float64', buffer, shape, strides, offset, 'row-major' );
+	* // returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
 	*
 	* var sh = getShape( x );
 	* // returns [ 3, 2 ]
 	*
-	* var arr = ndarray2array( x );
-	* // returns [ [ 1, 2 ], [ 3, 4 ], [ 5, 6 ] ]
-	*
 	* var y = ns.fliplr( x, false );
-	* // returns <ndarray>
+	* // returns <ndarray>[ [ 2.0, 1.0 ], [ 4.0, 3.0 ], [ 6.0, 5.0 ] ]
 	*
 	* sh = getShape( y );
 	* // returns [ 3, 2 ]
-	*
-	* arr = ndarray2array( y );
-	* // returns [ [ 2, 1 ], [ 4, 3 ], [ 6, 5 ] ]
 	*/
 	fliplr: typeof fliplr;
 
@@ -1896,37 +1889,31 @@ interface Namespace {
 	* @example
 	* var typedarray = require( '@stdlib/array/typed' );
 	* var ndarray = require( './../../../ctor' );
-	* var ndarray2array = require( './../../../to-array' );
+	* var getShape = require( './../../../shape' );
 	*
-	* var buffer = [ 1, 2, 3, 4, 5, 6 ];
+	* var buffer = typedarray( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ], 'float64' );
 	* var shape = [ 3, 2 ];
 	* var strides = [ 2, 1 ];
 	* var offset = 0;
 	*
-	* var x = ndarray( 'generic', buffer, shape, strides, offset, 'row-major' );
-	* // returns <ndarray>
+	* var x = ndarray( 'float64', buffer, shape, strides, offset, 'row-major' );
+	* // returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
 	*
-	* var sh = x.shape;
+	* var sh = getShape( x );
 	* // returns [ 3, 2 ]
 	*
-	* var arr = ndarray2array( x );
-	* // returns [ [ 1, 2 ], [ 3, 4 ], [ 5, 6 ] ]
-	*
 	* var y = ns.flipud( x, false );
-	* // returns <ndarray>
+	* // returns <ndarray>[ [ 5.0, 6.0 ], [ 3.0, 4.0 ], [ 1.0, 2.0 ] ]
 	*
-	* sh = y.shape;
+	* sh = getShape( y );
 	* // returns [ 3, 2 ]
-	*
-	* arr = ndarray2array( y );
-	* // returns [ [ 5, 6 ], [ 3, 4 ], [ 1, 2 ] ]
 	*/
 	flipud: typeof flipud;
 
 	/**
-	* Invokes a callback function once for each ndarray element.
+	* Invokes a callback function once for each element in an ndarray.
 	*
-	* @param arrays - array-like object containing an output ndarray
+	* @param arrays - array-like object containing an input ndarray
 	* @param fcn - callback function
 	* @param thisArg - callback function execution context
 	*
@@ -1948,7 +1935,7 @@ interface Namespace {
 	* // Define the index offset:
 	* var ox = 1;
 	*
-	* // Create the output ndarray:
+	* // Create the input ndarray:
 	* var x = ndarray( 'float64', xbuf, shape, sx, ox, 'row-major' );
 	*
 	* // Apply the callback function:
@@ -1964,12 +1951,14 @@ interface Namespace {
 	* @returns one-dimensional ndarray
 	*
 	* @example
+	* var getDType = require( './../../../dtype' );
+	*
 	* var arr = [ 1, 2, 3, 4 ];
 	*
 	* var x = ns.array2ndarray( arr, 'row-major' );
 	* // returns <ndarray>
 	*
-	* var dt = x.dtype;
+	* var dt = String( getDType( x ) );
 	* // returns 'generic'
 	*/
 	array2ndarray: typeof array2ndarray;
@@ -1983,13 +1972,16 @@ interface Namespace {
 	* @returns zero-dimensional ndarray
 	*
 	* @example
+	* var getShape = require( './../../../shape' );
+	* var getDType = require( './../../../dtype' );
+	*
 	* var x = ns.scalar2ndarray( 1.0, 'generic', 'row-major' );
 	* // returns <ndarray>
 	*
-	* var sh = x.shape;
+	* var sh = getShape( x );
 	* // returns []
 	*
-	* var dt = x.dtype;
+	* var dt = String( getDType( x ) );
 	* // returns 'generic'
 	*
 	* var v = x.get();