From 98a7087bd72f2f6b4a1dde5da5e9b7c4e81b5ddb Mon Sep 17 00:00:00 2001 From: Uday Kakade Date: Sat, 18 Apr 2026 23:00:56 +0530 Subject: [PATCH 1/6] docs: improve doctests for ndarray instances in ndaray/iter/stacks --- .../@stdlib/ndarray/iter/stacks/README.md | 20 +++---------------- .../@stdlib/ndarray/iter/stacks/docs/repl.txt | 5 ++--- .../ndarray/iter/stacks/docs/types/index.d.ts | 11 ++-------- .../@stdlib/ndarray/iter/stacks/lib/index.js | 11 ++-------- .../@stdlib/ndarray/iter/stacks/lib/main.js | 11 ++-------- 5 files changed, 11 insertions(+), 47 deletions(-) diff --git a/lib/node_modules/@stdlib/ndarray/iter/stacks/README.md b/lib/node_modules/@stdlib/ndarray/iter/stacks/README.md index 3db605266786..437c4c990fbd 100644 --- a/lib/node_modules/@stdlib/ndarray/iter/stacks/README.md +++ b/lib/node_modules/@stdlib/ndarray/iter/stacks/README.md @@ -46,7 +46,6 @@ 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 @@ -54,16 +53,10 @@ var x = array( [ [ [ 1, 2 ], [ 3, 4 ] ], [ [ 5, 6 ], [ 7, 8 ] ] ] ); var iter = nditerStacks( x, [ 1, 2 ] ); var v = iter.next().value; -// returns - -var arr = ndarray2array( v ); -// returns [ [ 1, 2 ], [ 3, 4 ] ] +// returns [ [ 1, 2 ], [ 3, 4 ] ] v = iter.next().value; -// returns - -arr = ndarray2array( v ); -// returns [ [ 5, 6 ], [ 7, 8 ] ] +// returns [ [ 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 @@ -86,15 +78,9 @@ var iter = nditerStacks( x, [ 1, 2 ], { }); var v = iter.next().value; -// returns - -var arr = ndarray2array( v ); -// returns [ [ 1, 2 ], [ 3, 4 ] ] +// returns [ [ 1, 2 ], [ 3, 4 ] ] v.set( 0, 0, 10 ); - -arr = ndarray2array( v ); -// returns [ [ 10, 2 ], [ 3, 4 ] ] ``` The returned [iterator][mdn-iterator-protocol] protocol-compliant object has the following properties: diff --git a/lib/node_modules/@stdlib/ndarray/iter/stacks/docs/repl.txt b/lib/node_modules/@stdlib/ndarray/iter/stacks/docs/repl.txt index de4d65dad0e6..964c7314e952 100644 --- a/lib/node_modules/@stdlib/ndarray/iter/stacks/docs/repl.txt +++ b/lib/node_modules/@stdlib/ndarray/iter/stacks/docs/repl.txt @@ -46,10 +46,9 @@ Examples -------- > var x = {{alias:@stdlib/ndarray/array}}( [ [ [ 1, 2 ], [ 3, 4 ] ] ] ); - > var it = {{alias}}( x, [ 1, 2 ] ); + > var it = {{alias}}( x, [ 1, 2 ] ) > var v = it.next().value; - > {{alias:@stdlib/ndarray/to-array}}( v ) - [ [ 1, 2 ], [ 3, 4 ] ] + [ [ 1, 2 ], [ 3, 4 ] ] See Also -------- diff --git a/lib/node_modules/@stdlib/ndarray/iter/stacks/docs/types/index.d.ts b/lib/node_modules/@stdlib/ndarray/iter/stacks/docs/types/index.d.ts index f6f448f5b883..379b12348af0 100644 --- a/lib/node_modules/@stdlib/ndarray/iter/stacks/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/ndarray/iter/stacks/docs/types/index.d.ts @@ -52,7 +52,6 @@ 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 @@ -60,16 +59,10 @@ interface Options { * var iter = nditerStacks( x, [ 1, 2 ] ); * * var v = iter.next().value; -* // returns -* -* var arr = ndarray2array( v ); -* // returns [ [ 1, 2 ], [ 3, 4 ] ] +* // returns [ [ 1, 2 ], [ 3, 4 ] ] * * v = iter.next().value; -* // returns -* -* arr = ndarray2array( v ); -* // returns [ [ 5, 6 ], [ 7, 8 ] ] +* // returns [ [ 5, 6 ], [ 7, 8 ] ] * * // ... */ diff --git a/lib/node_modules/@stdlib/ndarray/iter/stacks/lib/index.js b/lib/node_modules/@stdlib/ndarray/iter/stacks/lib/index.js index f1d9b1902743..a194e27e977a 100644 --- a/lib/node_modules/@stdlib/ndarray/iter/stacks/lib/index.js +++ b/lib/node_modules/@stdlib/ndarray/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 -* -* var arr = ndarray2array( v ); -* // returns [ [ 1, 2 ], [ 3, 4 ] ] +* // returns [ [ 1, 2 ], [ 3, 4 ] ] * * v = iter.next().value; -* // returns -* -* arr = ndarray2array( v ); -* // returns [ [ 5, 6 ], [ 7, 8 ] ] +* // returns [ [ 5, 6 ], [ 7, 8 ] ] * * // ... */ diff --git a/lib/node_modules/@stdlib/ndarray/iter/stacks/lib/main.js b/lib/node_modules/@stdlib/ndarray/iter/stacks/lib/main.js index fd15e464549c..24efb1abdcf1 100644 --- a/lib/node_modules/@stdlib/ndarray/iter/stacks/lib/main.js +++ b/lib/node_modules/@stdlib/ndarray/iter/stacks/lib/main.js @@ -63,7 +63,6 @@ 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 @@ -71,16 +70,10 @@ var format = require( '@stdlib/string/format' ); * var iter = nditerStacks( x, [ 1, 2 ] ); * * var v = iter.next().value; -* // returns -* -* var arr = ndarray2array( v ); -* // returns [ [ 1, 2 ], [ 3, 4 ] ] +* // returns [ [ 1, 2 ], [ 3, 4 ] ] * * v = iter.next().value; -* // returns -* -* arr = ndarray2array( v ); -* // returns [ [ 5, 6 ], [ 7, 8 ] ] +* // returns [ [ 5, 6 ], [ 7, 8 ] ] * * // ... */ From a35ea00cc4df493d318ce3b6acc87c14b70daab1 Mon Sep 17 00:00:00 2001 From: Uday Kakade <141299403+udaykakade25@users.noreply.github.com> Date: Sat, 18 Apr 2026 23:10:57 +0530 Subject: [PATCH 2/6] Fix Lint Error Signed-off-by: Uday Kakade <141299403+udaykakade25@users.noreply.github.com> --- lib/node_modules/@stdlib/ndarray/iter/stacks/docs/repl.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/ndarray/iter/stacks/docs/repl.txt b/lib/node_modules/@stdlib/ndarray/iter/stacks/docs/repl.txt index 964c7314e952..42fb61449be4 100644 --- a/lib/node_modules/@stdlib/ndarray/iter/stacks/docs/repl.txt +++ b/lib/node_modules/@stdlib/ndarray/iter/stacks/docs/repl.txt @@ -46,7 +46,7 @@ Examples -------- > var x = {{alias:@stdlib/ndarray/array}}( [ [ [ 1, 2 ], [ 3, 4 ] ] ] ); - > var it = {{alias}}( x, [ 1, 2 ] ) + > var it = {{alias}}( x, [ 1, 2 ] ); > var v = it.next().value; [ [ 1, 2 ], [ 3, 4 ] ] From dec70608a15158df404938e76da62e93caa0506a Mon Sep 17 00:00:00 2001 From: Uday Kakade <141299403+udaykakade25@users.noreply.github.com> Date: Sat, 18 Apr 2026 23:16:15 +0530 Subject: [PATCH 3/6] Fix Lint Errors in repl.txt Updated examples in repl.txt to remove trailing semicolons. Signed-off-by: Uday Kakade <141299403+udaykakade25@users.noreply.github.com> --- lib/node_modules/@stdlib/ndarray/iter/stacks/docs/repl.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/lib/node_modules/@stdlib/ndarray/iter/stacks/docs/repl.txt b/lib/node_modules/@stdlib/ndarray/iter/stacks/docs/repl.txt index 42fb61449be4..8591f77bc21a 100644 --- a/lib/node_modules/@stdlib/ndarray/iter/stacks/docs/repl.txt +++ b/lib/node_modules/@stdlib/ndarray/iter/stacks/docs/repl.txt @@ -45,9 +45,9 @@ Examples -------- - > var x = {{alias:@stdlib/ndarray/array}}( [ [ [ 1, 2 ], [ 3, 4 ] ] ] ); - > var it = {{alias}}( x, [ 1, 2 ] ); - > var v = it.next().value; + > var x = {{alias:@stdlib/ndarray/array}}( [ [ [ 1, 2 ], [ 3, 4 ] ] ] ) + > var it = {{alias}}( x, [ 1, 2 ] ) + > var v = it.next().value [ [ 1, 2 ], [ 3, 4 ] ] See Also From b760dd539c757d48e4d88ad31f309a437411c484 Mon Sep 17 00:00:00 2001 From: Athan Date: Sat, 18 Apr 2026 18:58:23 -0700 Subject: [PATCH 4/6] style: address lint failure Signed-off-by: Athan --- lib/node_modules/@stdlib/ndarray/iter/stacks/docs/repl.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/ndarray/iter/stacks/docs/repl.txt b/lib/node_modules/@stdlib/ndarray/iter/stacks/docs/repl.txt index 8591f77bc21a..3564e3473a62 100644 --- a/lib/node_modules/@stdlib/ndarray/iter/stacks/docs/repl.txt +++ b/lib/node_modules/@stdlib/ndarray/iter/stacks/docs/repl.txt @@ -46,7 +46,7 @@ Examples -------- > var x = {{alias:@stdlib/ndarray/array}}( [ [ [ 1, 2 ], [ 3, 4 ] ] ] ) - > var it = {{alias}}( x, [ 1, 2 ] ) + > var it = {{alias}}( x, [ 1, 2 ] ); > var v = it.next().value [ [ 1, 2 ], [ 3, 4 ] ] From 6b0d681fd7da2bbbbdd2480c14f272249173e420 Mon Sep 17 00:00:00 2001 From: Athan Date: Sat, 18 Apr 2026 18:58:53 -0700 Subject: [PATCH 5/6] style: add semicolon Signed-off-by: Athan --- lib/node_modules/@stdlib/ndarray/iter/stacks/docs/repl.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/ndarray/iter/stacks/docs/repl.txt b/lib/node_modules/@stdlib/ndarray/iter/stacks/docs/repl.txt index 3564e3473a62..0a9263d4533a 100644 --- a/lib/node_modules/@stdlib/ndarray/iter/stacks/docs/repl.txt +++ b/lib/node_modules/@stdlib/ndarray/iter/stacks/docs/repl.txt @@ -45,7 +45,7 @@ Examples -------- - > var x = {{alias:@stdlib/ndarray/array}}( [ [ [ 1, 2 ], [ 3, 4 ] ] ] ) + > var x = {{alias:@stdlib/ndarray/array}}( [ [ [ 1, 2 ], [ 3, 4 ] ] ] ); > var it = {{alias}}( x, [ 1, 2 ] ); > var v = it.next().value [ [ 1, 2 ], [ 3, 4 ] ] From 60d78366a20d85f89ba67d58e3d540c3640d1de7 Mon Sep 17 00:00:00 2001 From: Athan Date: Sat, 18 Apr 2026 19:00:35 -0700 Subject: [PATCH 6/6] docs: add return annotation Signed-off-by: Athan --- lib/node_modules/@stdlib/ndarray/iter/stacks/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/lib/node_modules/@stdlib/ndarray/iter/stacks/README.md b/lib/node_modules/@stdlib/ndarray/iter/stacks/README.md index 437c4c990fbd..c17e0d47ed4e 100644 --- a/lib/node_modules/@stdlib/ndarray/iter/stacks/README.md +++ b/lib/node_modules/@stdlib/ndarray/iter/stacks/README.md @@ -81,6 +81,7 @@ var v = iter.next().value; // returns [ [ 1, 2 ], [ 3, 4 ] ] v.set( 0, 0, 10 ); +// v => [ [ 10, 2 ], [ 3, 4 ] ] ``` The returned [iterator][mdn-iterator-protocol] protocol-compliant object has the following properties: