Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -850,6 +850,7 @@ A total of 49 issues were closed in this release:
 
 <details>
 
+-   [`5e89f8b`](https://github.com/stdlib-js/stdlib/commit/5e89f8b25d48b08a844cbb05f943de3c3121f0d0) - **docs:** improve doctests for ndarray instances in `ndaray/iter/stacks` [(#11539)](https://github.com/stdlib-js/stdlib/pull/11539) _(by Uday Kakade, Athan Reines)_
 -   [`07bcff6`](https://github.com/stdlib-js/stdlib/commit/07bcff64aac9d1c61b327b8986bbf34e1643b0ba) - **refactor:** import method directly _(by Athan Reines)_
 -   [`c4ace9d`](https://github.com/stdlib-js/stdlib/commit/c4ace9d015730f6552a6994c34b5ea8d5480e9e5) - **refactor:** create read-only views _(by Athan Reines)_
 -   [`414d61b`](https://github.com/stdlib-js/stdlib/commit/414d61b8adf854cfa4582bd9659c760b03bc40a7) - **feat:** add `colcat` to namespace _(by Athan Reines)_

iter/stacks/README.md

@@ -46,24 +46,17 @@ Returns an iterator which iterates over each subarray in a stack of subarrays ac
 
 ```javascript
 var array = require( '@stdlib/ndarray/array' );
-var ndarray2array = require( '@stdlib/ndarray/to-array' );
 
 var x = array( [ [ [ 1, 2 ], [ 3, 4 ] ], [ [ 5, 6 ], [ 7, 8 ] ] ] );
 // returns <ndarray>
 
 var iter = nditerStacks( x, [ 1, 2 ] );
 
 var v = iter.next().value;
-// returns <ndarray>
-
-var arr = ndarray2array( v );
-// returns [ [ 1, 2 ], [ 3, 4 ] ]
+// returns <ndarray>[ [ 1, 2 ], [ 3, 4 ] ]
 
 v = iter.next().value;
-// returns <ndarray>
-
-arr = ndarray2array( v );
-// returns [ [ 5, 6 ], [ 7, 8 ] ]
+// returns <ndarray>[ [ 5, 6 ], [ 7, 8 ] ]
 
 // ...
 ```
@@ -76,7 +69,6 @@ By default, the iterator returns [`ndarray`][@stdlib/ndarray/ctor] views which a
 
 ```javascript
 var array = require( '@stdlib/ndarray/array' );
-var ndarray2array = require( '@stdlib/ndarray/to-array' );
 
 var x = array( [ [ [ 1, 2 ], [ 3, 4 ] ], [ [ 5, 6 ], [ 7, 8 ] ] ] );
 // returns <ndarray>
@@ -86,15 +78,10 @@ var iter = nditerStacks( x, [ 1, 2 ], {
 });
 
 var v = iter.next().value;
-// returns <ndarray>
-
-var arr = ndarray2array( v );
-// returns [ [ 1, 2 ], [ 3, 4 ] ]
+// returns <ndarray>[ [ 1, 2 ], [ 3, 4 ] ]
 
 v.set( 0, 0, 10 );
-
-arr = ndarray2array( v );
-// returns [ [ 10, 2 ], [ 3, 4 ] ]
+// v => <ndarray>[ [ 10, 2 ], [ 3, 4 ] ]
 ```
 
 The returned [iterator][mdn-iterator-protocol] protocol-compliant object has the following properties:

iter/stacks/docs/repl.txt

@@ -47,9 +47,8 @@
     --------
     > var x = {{alias:@stdlib/ndarray/array}}( [ [ [ 1, 2 ], [ 3, 4 ] ] ] );
     > var it = {{alias}}( x, [ 1, 2 ] );
-    > var v = it.next().value;
-    > {{alias:@stdlib/ndarray/to-array}}( v )
-    [ [ 1, 2 ], [ 3, 4 ] ]
+    > var v = it.next().value
+    <ndarray>[ [ 1, 2 ], [ 3, 4 ] ]
 
     See Also
     --------

iter/stacks/docs/types/index.d.ts

@@ -52,24 +52,17 @@ interface Options {
 *
 * @example
 * var array = require( '@stdlib/ndarray/array' );
-* var ndarray2array = require( '@stdlib/ndarray/to-array' );
 *
 * var x = array( [ [ [ 1, 2 ], [ 3, 4 ] ], [ [ 5, 6 ], [ 7, 8 ] ] ] );
 * // returns <ndarray>
 *
 * var iter = nditerStacks( x, [ 1, 2 ] );
 *
 * var v = iter.next().value;
-* // returns <ndarray>
-*
-* var arr = ndarray2array( v );
-* // returns [ [ 1, 2 ], [ 3, 4 ] ]
+* // returns <ndarray>[ [ 1, 2 ], [ 3, 4 ] ]
 *
 * v = iter.next().value;
-* // returns <ndarray>
-*
-* arr = ndarray2array( v );
-* // returns [ [ 5, 6 ], [ 7, 8 ] ]
+* // returns <ndarray>[ [ 5, 6 ], [ 7, 8 ] ]
 *
 * // ...
 */

iter/stacks/lib/index.js

@@ -25,7 +25,6 @@
 *
 * @example
 * var array = require( '@stdlib/ndarray/array' );
-* var ndarray2array = require( '@stdlib/ndarray/to-array' );
 * var nditerStacks = require( '@stdlib/ndarray/iter/stacks' );
 *
 * var x = array( [ [ [ 1, 2 ], [ 3, 4 ] ], [ [ 5, 6 ], [ 7, 8 ] ] ] );
@@ -34,16 +33,10 @@
 * var iter = nditerStacks( x, [ 1, 2 ] );
 *
 * var v = iter.next().value;
-* // returns <ndarray>
-*
-* var arr = ndarray2array( v );
-* // returns [ [ 1, 2 ], [ 3, 4 ] ]
+* // returns <ndarray>[ [ 1, 2 ], [ 3, 4 ] ]
 *
 * v = iter.next().value;
-* // returns <ndarray>
-*
-* arr = ndarray2array( v );
-* // returns [ [ 5, 6 ], [ 7, 8 ] ]
+* // returns <ndarray>[ [ 5, 6 ], [ 7, 8 ] ]
 *
 * // ...
 */

iter/stacks/lib/main.js

@@ -63,24 +63,17 @@ var format = require( '@stdlib/string/format' );
 *
 * @example
 * var array = require( '@stdlib/ndarray/array' );
-* var ndarray2array = require( '@stdlib/ndarray/to-array' );
 *
 * var x = array( [ [ [ 1, 2 ], [ 3, 4 ] ], [ [ 5, 6 ], [ 7, 8 ] ] ] );
 * // returns <ndarray>
 *
 * var iter = nditerStacks( x, [ 1, 2 ] );
 *
 * var v = iter.next().value;
-* // returns <ndarray>
-*
-* var arr = ndarray2array( v );
-* // returns [ [ 1, 2 ], [ 3, 4 ] ]
+* // returns <ndarray>[ [ 1, 2 ], [ 3, 4 ] ]
 *
 * v = iter.next().value;
-* // returns <ndarray>
-*
-* arr = ndarray2array( v );
-* // returns [ [ 5, 6 ], [ 7, 8 ] ]
+* // returns <ndarray>[ [ 5, 6 ], [ 7, 8 ] ]
 *
 * // ...
 */