Skip to content

Commit 5e89f8b

Browse files
udaykakade25kgryte
andauthored
docs: improve doctests for ndarray instances in ndaray/iter/stacks
PR-URL: #11539 Co-authored-by: Athan Reines <kgryte@gmail.com> Reviewed-by: Athan Reines <kgryte@gmail.com> Ref: #9329
1 parent 07bcff6 commit 5e89f8b

5 files changed

Lines changed: 12 additions & 47 deletions

File tree

lib/node_modules/@stdlib/ndarray/iter/stacks/README.md

Lines changed: 4 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -46,24 +46,17 @@ Returns an iterator which iterates over each subarray in a stack of subarrays ac
4646

4747
```javascript
4848
var array = require( '@stdlib/ndarray/array' );
49-
var ndarray2array = require( '@stdlib/ndarray/to-array' );
5049

5150
var x = array( [ [ [ 1, 2 ], [ 3, 4 ] ], [ [ 5, 6 ], [ 7, 8 ] ] ] );
5251
// returns <ndarray>
5352

5453
var iter = nditerStacks( x, [ 1, 2 ] );
5554

5655
var v = iter.next().value;
57-
// returns <ndarray>
58-
59-
var arr = ndarray2array( v );
60-
// returns [ [ 1, 2 ], [ 3, 4 ] ]
56+
// returns <ndarray>[ [ 1, 2 ], [ 3, 4 ] ]
6157

6258
v = iter.next().value;
63-
// returns <ndarray>
64-
65-
arr = ndarray2array( v );
66-
// returns [ [ 5, 6 ], [ 7, 8 ] ]
59+
// returns <ndarray>[ [ 5, 6 ], [ 7, 8 ] ]
6760

6861
// ...
6962
```
@@ -76,7 +69,6 @@ By default, the iterator returns [`ndarray`][@stdlib/ndarray/ctor] views which a
7669

7770
```javascript
7871
var array = require( '@stdlib/ndarray/array' );
79-
var ndarray2array = require( '@stdlib/ndarray/to-array' );
8072

8173
var x = array( [ [ [ 1, 2 ], [ 3, 4 ] ], [ [ 5, 6 ], [ 7, 8 ] ] ] );
8274
// returns <ndarray>
@@ -86,15 +78,10 @@ var iter = nditerStacks( x, [ 1, 2 ], {
8678
});
8779

8880
var v = iter.next().value;
89-
// returns <ndarray>
90-
91-
var arr = ndarray2array( v );
92-
// returns [ [ 1, 2 ], [ 3, 4 ] ]
81+
// returns <ndarray>[ [ 1, 2 ], [ 3, 4 ] ]
9382

9483
v.set( 0, 0, 10 );
95-
96-
arr = ndarray2array( v );
97-
// returns [ [ 10, 2 ], [ 3, 4 ] ]
84+
// v => <ndarray>[ [ 10, 2 ], [ 3, 4 ] ]
9885
```
9986

10087
The returned [iterator][mdn-iterator-protocol] protocol-compliant object has the following properties:

lib/node_modules/@stdlib/ndarray/iter/stacks/docs/repl.txt

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,8 @@
4747
--------
4848
> var x = {{alias:@stdlib/ndarray/array}}( [ [ [ 1, 2 ], [ 3, 4 ] ] ] );
4949
> var it = {{alias}}( x, [ 1, 2 ] );
50-
> var v = it.next().value;
51-
> {{alias:@stdlib/ndarray/to-array}}( v )
52-
[ [ 1, 2 ], [ 3, 4 ] ]
50+
> var v = it.next().value
51+
<ndarray>[ [ 1, 2 ], [ 3, 4 ] ]
5352

5453
See Also
5554
--------

lib/node_modules/@stdlib/ndarray/iter/stacks/docs/types/index.d.ts

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -52,24 +52,17 @@ interface Options {
5252
*
5353
* @example
5454
* var array = require( '@stdlib/ndarray/array' );
55-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
5655
*
5756
* var x = array( [ [ [ 1, 2 ], [ 3, 4 ] ], [ [ 5, 6 ], [ 7, 8 ] ] ] );
5857
* // returns <ndarray>
5958
*
6059
* var iter = nditerStacks( x, [ 1, 2 ] );
6160
*
6261
* var v = iter.next().value;
63-
* // returns <ndarray>
64-
*
65-
* var arr = ndarray2array( v );
66-
* // returns [ [ 1, 2 ], [ 3, 4 ] ]
62+
* // returns <ndarray>[ [ 1, 2 ], [ 3, 4 ] ]
6763
*
6864
* v = iter.next().value;
69-
* // returns <ndarray>
70-
*
71-
* arr = ndarray2array( v );
72-
* // returns [ [ 5, 6 ], [ 7, 8 ] ]
65+
* // returns <ndarray>[ [ 5, 6 ], [ 7, 8 ] ]
7366
*
7467
* // ...
7568
*/

lib/node_modules/@stdlib/ndarray/iter/stacks/lib/index.js

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@
2525
*
2626
* @example
2727
* var array = require( '@stdlib/ndarray/array' );
28-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
2928
* var nditerStacks = require( '@stdlib/ndarray/iter/stacks' );
3029
*
3130
* var x = array( [ [ [ 1, 2 ], [ 3, 4 ] ], [ [ 5, 6 ], [ 7, 8 ] ] ] );
@@ -34,16 +33,10 @@
3433
* var iter = nditerStacks( x, [ 1, 2 ] );
3534
*
3635
* var v = iter.next().value;
37-
* // returns <ndarray>
38-
*
39-
* var arr = ndarray2array( v );
40-
* // returns [ [ 1, 2 ], [ 3, 4 ] ]
36+
* // returns <ndarray>[ [ 1, 2 ], [ 3, 4 ] ]
4137
*
4238
* v = iter.next().value;
43-
* // returns <ndarray>
44-
*
45-
* arr = ndarray2array( v );
46-
* // returns [ [ 5, 6 ], [ 7, 8 ] ]
39+
* // returns <ndarray>[ [ 5, 6 ], [ 7, 8 ] ]
4740
*
4841
* // ...
4942
*/

lib/node_modules/@stdlib/ndarray/iter/stacks/lib/main.js

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -63,24 +63,17 @@ var format = require( '@stdlib/string/format' );
6363
*
6464
* @example
6565
* var array = require( '@stdlib/ndarray/array' );
66-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
6766
*
6867
* var x = array( [ [ [ 1, 2 ], [ 3, 4 ] ], [ [ 5, 6 ], [ 7, 8 ] ] ] );
6968
* // returns <ndarray>
7069
*
7170
* var iter = nditerStacks( x, [ 1, 2 ] );
7271
*
7372
* var v = iter.next().value;
74-
* // returns <ndarray>
75-
*
76-
* var arr = ndarray2array( v );
77-
* // returns [ [ 1, 2 ], [ 3, 4 ] ]
73+
* // returns <ndarray>[ [ 1, 2 ], [ 3, 4 ] ]
7874
*
7975
* v = iter.next().value;
80-
* // returns <ndarray>
81-
*
82-
* arr = ndarray2array( v );
83-
* // returns [ [ 5, 6 ], [ 7, 8 ] ]
76+
* // returns <ndarray>[ [ 5, 6 ], [ 7, 8 ] ]
8477
*
8578
* // ...
8679
*/

0 commit comments

Comments
 (0)