From 7d1fee9772f8485ebb4dc9d996d6a31e84f6e3a2 Mon Sep 17 00:00:00 2001 From: Claude Date: Sun, 19 Apr 2026 13:50:50 +0000 Subject: [PATCH 1/5] docs: improve doctests for ndarray instances in `blas/ext/base/ndarray/dcusum*` Propagates fix from 638fdf01 ("docs: improve doctests for ndarray instances in `blas/ext/base/ndarray/gcusumkbn2`") to the five `dcusum*` sibling packages (dcusum, dcusumkbn, dcusumkbn2, dcusumors, dcusumpw), collapsing the two-step `{{alias}}(...);` + `{{alias:@stdlib/ndarray/to-array}}(y)` REPL doctest into the inline `[ ... ]` form. --- .../@stdlib/blas/ext/base/ndarray/dcusum/docs/repl.txt | 5 ++--- .../@stdlib/blas/ext/base/ndarray/dcusumkbn/docs/repl.txt | 5 ++--- .../@stdlib/blas/ext/base/ndarray/dcusumkbn2/docs/repl.txt | 5 ++--- .../@stdlib/blas/ext/base/ndarray/dcusumors/docs/repl.txt | 5 ++--- .../@stdlib/blas/ext/base/ndarray/dcusumpw/docs/repl.txt | 5 ++--- 5 files changed, 10 insertions(+), 15 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcusum/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcusum/docs/repl.txt index 32e21bba09c5..7c754709f982 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcusum/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcusum/docs/repl.txt @@ -30,9 +30,8 @@ > var x = new {{alias:@stdlib/ndarray/ctor}}( dt, xbuf, sh, st, oo, ord ); > var y = new {{alias:@stdlib/ndarray/ctor}}( dt, ybuf, sh, st, oo, ord ); > var s = {{alias:@stdlib/ndarray/from-scalar}}( 0.0, { 'dtype': dt } ); - > {{alias}}( [ x, y, s ] ); - > {{alias:@stdlib/ndarray/to-array}}( y ) - [ 1.0, -1.0, 1.0 ] + > {{alias}}( [ x, y, s ] ) + [ 1.0, -1.0, 1.0 ] See Also -------- diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcusumkbn/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcusumkbn/docs/repl.txt index 6cdda69cba10..72bd50322ebb 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcusumkbn/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcusumkbn/docs/repl.txt @@ -30,9 +30,8 @@ > var x = new {{alias:@stdlib/ndarray/ctor}}( dt, xbuf, sh, st, oo, ord ); > var y = new {{alias:@stdlib/ndarray/ctor}}( dt, ybuf, sh, st, oo, ord ); > var s = {{alias:@stdlib/ndarray/from-scalar}}( 0.0, { 'dtype': dt } ); - > {{alias}}( [ x, y, s ] ); - > {{alias:@stdlib/ndarray/to-array}}( y ) - [ 1.0, -1.0, 1.0 ] + > {{alias}}( [ x, y, s ] ) + [ 1.0, -1.0, 1.0 ] See Also -------- diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcusumkbn2/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcusumkbn2/docs/repl.txt index 7c015c1b2f35..ede9325b1840 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcusumkbn2/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcusumkbn2/docs/repl.txt @@ -30,9 +30,8 @@ > var x = new {{alias:@stdlib/ndarray/ctor}}( dt, xbuf, sh, st, oo, ord ); > var y = new {{alias:@stdlib/ndarray/ctor}}( dt, ybuf, sh, st, oo, ord ); > var s = {{alias:@stdlib/ndarray/from-scalar}}( 0.0, { 'dtype': dt } ); - > {{alias}}( [ x, y, s ] ); - > {{alias:@stdlib/ndarray/to-array}}( y ) - [ 1.0, -1.0, 1.0 ] + > {{alias}}( [ x, y, s ] ) + [ 1.0, -1.0, 1.0 ] See Also -------- diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcusumors/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcusumors/docs/repl.txt index 2e566dab2195..f2f43cd5fca4 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcusumors/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcusumors/docs/repl.txt @@ -30,9 +30,8 @@ > var x = new {{alias:@stdlib/ndarray/ctor}}( dt, xbuf, sh, st, oo, ord ); > var y = new {{alias:@stdlib/ndarray/ctor}}( dt, ybuf, sh, st, oo, ord ); > var s = {{alias:@stdlib/ndarray/from-scalar}}( 0.0, { 'dtype': dt } ); - > {{alias}}( [ x, y, s ] ); - > {{alias:@stdlib/ndarray/to-array}}( y ) - [ 1.0, -1.0, 1.0 ] + > {{alias}}( [ x, y, s ] ) + [ 1.0, -1.0, 1.0 ] See Also -------- diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcusumpw/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcusumpw/docs/repl.txt index fccedf49d922..f7c525f31c3f 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcusumpw/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcusumpw/docs/repl.txt @@ -30,9 +30,8 @@ > var x = new {{alias:@stdlib/ndarray/ctor}}( dt, xbuf, sh, st, oo, ord ); > var y = new {{alias:@stdlib/ndarray/ctor}}( dt, ybuf, sh, st, oo, ord ); > var s = {{alias:@stdlib/ndarray/from-scalar}}( 0.0, { 'dtype': dt } ); - > {{alias}}( [ x, y, s ] ); - > {{alias:@stdlib/ndarray/to-array}}( y ) - [ 1.0, -1.0, 1.0 ] + > {{alias}}( [ x, y, s ] ) + [ 1.0, -1.0, 1.0 ] See Also -------- From 16ce41e808a3a0675d04f431045830411842d7e6 Mon Sep 17 00:00:00 2001 From: Claude Date: Sun, 19 Apr 2026 13:51:11 +0000 Subject: [PATCH 2/5] docs: improve doctests for ndarray instances in `blas` namespace Propagates fix from 97d6f49c ("docs: improve doctests for ndarray instances in `blas/sdot`") to the `sdot` @example entry in `blas/docs/types/index.d.ts`, collapsing the `// returns ` + `var v = z.get();` two-step pattern into the inline `[ -5.0 ]` form used by the adjacent `ddot` entry. --- lib/node_modules/@stdlib/blas/docs/types/index.d.ts | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/docs/types/index.d.ts index 5c48fec83606..a42dcddbafb6 100644 --- a/lib/node_modules/@stdlib/blas/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/docs/types/index.d.ts @@ -188,10 +188,7 @@ interface Namespace { * var y = array( new Float32Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] ) ); * * var z = ns.sdot( x, y ); - * // returns - * - * var v = z.get(); - * // returns -5.0 + * // returns [ -5.0 ] */ sdot: typeof sdot; From 81a545e8f7cf7e529c8fa6457e6f38d68d7137c8 Mon Sep 17 00:00:00 2001 From: Claude Date: Sun, 19 Apr 2026 13:51:32 +0000 Subject: [PATCH 3/5] docs: remove orphan `ndarray2array` require in `stats/base/ndarray/cumin` Propagates fix from 0873811a ("docs: inline ndarray output in doctests and add missing article") to `stats/base/ndarray/cumin/lib/main.js`, removing the orphan `@stdlib/ndarray/to-array` require in the `@example` block since the output is already shown via the inline `[ ... ]` form. --- lib/node_modules/@stdlib/stats/base/ndarray/cumin/lib/main.js | 1 - 1 file changed, 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/cumin/lib/main.js b/lib/node_modules/@stdlib/stats/base/ndarray/cumin/lib/main.js index a52400451879..2248ba0aacf8 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/cumin/lib/main.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/cumin/lib/main.js @@ -36,7 +36,6 @@ var strided = require( '@stdlib/stats/base/cumin' ).ndarray; * @returns {ndarrayLike} output ndarray * * @example -* var ndarray2array = require( '@stdlib/ndarray/to-array' ); * var ndarray = require( '@stdlib/ndarray/base/ctor' ); * * var xbuf = [ 1.0, 3.0, 4.0, 2.0 ]; From 8adce00aa2d2bcc0bfa128d20e9c61934c9e5d9e Mon Sep 17 00:00:00 2001 From: Claude Date: Sun, 19 Apr 2026 13:51:53 +0000 Subject: [PATCH 4/5] chore: fix JavaScript lint errors Propagates fix from 650bf8ac ("chore: fix JavaScript lint errors") to sibling example files that still build error messages via string concatenation. Replaces `new Error( 'text: ' + value )` with `new Error( format( 'text: %s', value ) )` and adds the `@stdlib/string/format` import across `utils/async/inmap`, `utils/async/inmap-right`, `utils/async/for-each`, and `datasets/us-states-capitals-names` examples. --- .../datasets/us-states-capitals-names/examples/index.js | 3 ++- .../@stdlib/utils/async/for-each/examples/index.js | 3 ++- .../@stdlib/utils/async/inmap-right/examples/index.js | 3 ++- lib/node_modules/@stdlib/utils/async/inmap/examples/index.js | 3 ++- 4 files changed, 8 insertions(+), 4 deletions(-) diff --git a/lib/node_modules/@stdlib/datasets/us-states-capitals-names/examples/index.js b/lib/node_modules/@stdlib/datasets/us-states-capitals-names/examples/index.js index 8c36e06384ae..43dcde03faf3 100644 --- a/lib/node_modules/@stdlib/datasets/us-states-capitals-names/examples/index.js +++ b/lib/node_modules/@stdlib/datasets/us-states-capitals-names/examples/index.js @@ -19,6 +19,7 @@ 'use strict'; var capitalize = require( '@stdlib/string/capitalize' ); +var format = require( '@stdlib/string/format' ); var table = require( './../lib' ); var tbl = table(); @@ -38,7 +39,7 @@ function getState( capital ) { // Ensure a valid capital name was provided... if ( state === void 0 ) { - throw new Error( 'unrecognized capital. Value: `' + capital + '`.' ); + throw new Error( format( 'unrecognized capital. Value: `%s`.', capital ) ); } return state; } diff --git a/lib/node_modules/@stdlib/utils/async/for-each/examples/index.js b/lib/node_modules/@stdlib/utils/async/for-each/examples/index.js index 67aba83611b0..0e98b998e31d 100644 --- a/lib/node_modules/@stdlib/utils/async/for-each/examples/index.js +++ b/lib/node_modules/@stdlib/utils/async/for-each/examples/index.js @@ -20,6 +20,7 @@ var resolve = require( 'path' ).resolve; var readFile = require( '@stdlib/fs/read-file' ); +var format = require( '@stdlib/string/format' ); var forEachAsync = require( './../lib' ); var files = [ @@ -42,7 +43,7 @@ function read( file, next ) { function onFile( error ) { if ( error ) { - error = new Error( 'unable to read file: '+file ); + error = new Error( format( 'unable to read file: %s', file ) ); return next( error ); } console.log( 'Successfully read file: %s', file ); diff --git a/lib/node_modules/@stdlib/utils/async/inmap-right/examples/index.js b/lib/node_modules/@stdlib/utils/async/inmap-right/examples/index.js index a5c6653a0e94..9dc52dd9c393 100644 --- a/lib/node_modules/@stdlib/utils/async/inmap-right/examples/index.js +++ b/lib/node_modules/@stdlib/utils/async/inmap-right/examples/index.js @@ -20,6 +20,7 @@ var resolve = require( 'path' ).resolve; var readFile = require( '@stdlib/fs/read-file' ); +var format = require( '@stdlib/string/format' ); var inmapRightAsync = require( './../lib' ); var files = [ @@ -42,7 +43,7 @@ function read( file, next ) { function onFile( error, data ) { if ( error ) { - error = new Error( 'unable to read file: '+file ); + error = new Error( format( 'unable to read file: %s', file ) ); return next( error ); } next( null, data ); diff --git a/lib/node_modules/@stdlib/utils/async/inmap/examples/index.js b/lib/node_modules/@stdlib/utils/async/inmap/examples/index.js index 0bdcf810f9ea..402400ede65e 100644 --- a/lib/node_modules/@stdlib/utils/async/inmap/examples/index.js +++ b/lib/node_modules/@stdlib/utils/async/inmap/examples/index.js @@ -20,6 +20,7 @@ var resolve = require( 'path' ).resolve; var readFile = require( '@stdlib/fs/read-file' ); +var format = require( '@stdlib/string/format' ); var inmapAsync = require( './../lib' ); var files = [ @@ -42,7 +43,7 @@ function read( file, next ) { function onFile( error, data ) { if ( error ) { - error = new Error( 'unable to read file: '+file ); + error = new Error( format( 'unable to read file: %s', file ) ); return next( error ); } next( null, data ); From e422e6a345826b99a2aef1e214f38b3da61c42cb Mon Sep 17 00:00:00 2001 From: Claude Date: Sun, 19 Apr 2026 19:11:03 +0000 Subject: [PATCH 5/5] chore: propagate `format` migration to README examples Extends 8adce00a to the matching README example blocks. Athan Reines flagged that the `examples/index.js` fix needed to land in the READMEs too; updates `utils/async/inmap`, `utils/async/inmap-right`, `utils/async/for-each`, and `datasets/us-states-capitals-names` README examples to use `@stdlib/string/format` instead of string concatenation inside `new Error(...)`. --- .../@stdlib/datasets/us-states-capitals-names/README.md | 3 ++- lib/node_modules/@stdlib/utils/async/for-each/README.md | 3 ++- lib/node_modules/@stdlib/utils/async/inmap-right/README.md | 3 ++- lib/node_modules/@stdlib/utils/async/inmap/README.md | 3 ++- 4 files changed, 8 insertions(+), 4 deletions(-) diff --git a/lib/node_modules/@stdlib/datasets/us-states-capitals-names/README.md b/lib/node_modules/@stdlib/datasets/us-states-capitals-names/README.md index 1954eb970624..32cf1119ba4a 100644 --- a/lib/node_modules/@stdlib/datasets/us-states-capitals-names/README.md +++ b/lib/node_modules/@stdlib/datasets/us-states-capitals-names/README.md @@ -104,6 +104,7 @@ var t = table(); ```javascript var capitalize = require( '@stdlib/string/capitalize' ); +var format = require( '@stdlib/string/format' ); var table = require( '@stdlib/datasets/us-states-capitals-names' ); var tbl = table(); @@ -123,7 +124,7 @@ function getState( capital ) { // Ensure a valid capital name was provided... if ( state === void 0 ) { - throw new Error( 'unrecognized capital. Value: `' + capital + '`.' ); + throw new Error( format( 'unrecognized capital. Value: `%s`.', capital ) ); } return state; } diff --git a/lib/node_modules/@stdlib/utils/async/for-each/README.md b/lib/node_modules/@stdlib/utils/async/for-each/README.md index 2b3878ba8139..3d054d4f7168 100644 --- a/lib/node_modules/@stdlib/utils/async/for-each/README.md +++ b/lib/node_modules/@stdlib/utils/async/for-each/README.md @@ -280,6 +280,7 @@ The function accepts the same `options` as `forEachAsync()`. ```javascript var resolve = require( 'path' ).resolve; var readFile = require( '@stdlib/fs/read-file' ); +var format = require( '@stdlib/string/format' ); var forEachAsync = require( '@stdlib/utils/async/for-each' ); var files = [ @@ -302,7 +303,7 @@ function read( file, next ) { function onFile( error ) { if ( error ) { - error = new Error( 'unable to read file: '+file ); + error = new Error( format( 'unable to read file: %s', file ) ); return next( error ); } console.log( 'Successfully read file: %s', file ); diff --git a/lib/node_modules/@stdlib/utils/async/inmap-right/README.md b/lib/node_modules/@stdlib/utils/async/inmap-right/README.md index 97eafe939b9f..066ca85b0cb9 100644 --- a/lib/node_modules/@stdlib/utils/async/inmap-right/README.md +++ b/lib/node_modules/@stdlib/utils/async/inmap-right/README.md @@ -366,6 +366,7 @@ The function accepts the same `options` as `inmapRightAsync()`. ```javascript var resolve = require( 'path' ).resolve; var readFile = require( '@stdlib/fs/read-file' ); +var format = require( '@stdlib/string/format' ); var inmapRightAsync = require( '@stdlib/utils/async/inmap-right' ); var files = [ @@ -388,7 +389,7 @@ function read( file, next ) { function onFile( error, data ) { if ( error ) { - error = new Error( 'unable to read file: '+file ); + error = new Error( format( 'unable to read file: %s', file ) ); return next( error ); } next( null, data ); diff --git a/lib/node_modules/@stdlib/utils/async/inmap/README.md b/lib/node_modules/@stdlib/utils/async/inmap/README.md index 4850f64eb0df..feb318efc2e8 100644 --- a/lib/node_modules/@stdlib/utils/async/inmap/README.md +++ b/lib/node_modules/@stdlib/utils/async/inmap/README.md @@ -367,6 +367,7 @@ The function accepts the same `options` as `inmapAsync()`. ```javascript var resolve = require( 'path' ).resolve; var readFile = require( '@stdlib/fs/read-file' ); +var format = require( '@stdlib/string/format' ); var inmapAsync = require( '@stdlib/utils/async/inmap' ); var files = [ @@ -389,7 +390,7 @@ function read( file, next ) { function onFile( error, data ) { if ( error ) { - error = new Error( 'unable to read file: '+file ); + error = new Error( format( 'unable to read file: %s', file ) ); return next( error ); } next( null, data );