Skip to content

docs: improve doctests for ndarray instances in ndaray/iter/stacks #11539

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kgryte merged 6 commits into from
Apr 19, 2026
Merged

docs: improve doctests for ndarray instances in ndaray/iter/stacks #11539

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
98a7087
docs: improve doctests for ndarray instances in ndaray/iter/stacks
udaykakade25 Apr 18, 2026
a35ea00
Fix Lint Error
udaykakade25 Apr 18, 2026
dec7060
Fix Lint Errors in repl.txt
udaykakade25 Apr 18, 2026
b760dd5
style: address lint failure
kgryte Apr 19, 2026
6b0d681
style: add semicolon
kgryte Apr 19, 2026
60d7836
docs: add return annotation
kgryte Apr 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 4 additions & 17 deletions lib/node_modules/@stdlib/ndarray/iter/stacks/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 ] ]

// ...
```
Expand All @@ -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>
Expand All @@ -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 );
Comment thread
kgryte marked this conversation as resolved.

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:
Expand Down
5 changes: 2 additions & 3 deletions lib/node_modules/@stdlib/ndarray/iter/stacks/docs/repl.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
--------
Expand Down
11 changes: 2 additions & 9 deletions lib/node_modules/@stdlib/ndarray/iter/stacks/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 ] ]
*
* // ...
*/
Expand Down
11 changes: 2 additions & 9 deletions lib/node_modules/@stdlib/ndarray/iter/stacks/lib/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 ] ] ] );
Expand All @@ -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 ] ]
*
* // ...
*/
Expand Down
11 changes: 2 additions & 9 deletions lib/node_modules/@stdlib/ndarray/iter/stacks/lib/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 ] ]
*
* // ...
*/
Expand Down