docs: improve doctests for ndarray instances in ndarray/dcusumpw

bhargava-d16 · web-flow · commit 2b2ae6abbdb5 · 2026-01-31T01:11:59.000-08:00
PR-URL: stdlib-js#10005 Ref: stdlib-js#9329 Reviewed-by: Athan Reines <kgryte@gmail.com>
diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcusumpw/README.md b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcusumpw/README.md
@@ -42,7 +42,6 @@ Computes the cumulative sum of a one-dimensional double-precision floating-point
 
 ```javascript
 var Float64Array = require( '@stdlib/array/float64' );
-var ndarray2array = require( '@stdlib/ndarray/to-array' );
 var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' );
 var ndarray = require( '@stdlib/ndarray/base/ctor' );
 
@@ -55,13 +54,10 @@ var y = new ndarray( 'float64', ybuf, [ 4 ], [ 1 ], 0, 'row-major' );
 var initial = scalar2ndarray( 0.0, 'float64', 'row-major' );
 
 var v = dcusumpw( [ x, y, initial ] );
-// returns <ndarray>
+// returns <ndarray>[ 1.0, 4.0, 8.0, 10.0 ]
 
 var bool = ( v === y );
 // returns true
-
-var arr = ndarray2array( v );
-// returns [ 1.0, 4.0, 8.0, 10.0 ]
 ```
 
 The function has the following parameters:
diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcusumpw/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcusumpw/docs/types/index.d.ts
@@ -30,7 +30,6 @@ import { float64ndarray } from '@stdlib/types/ndarray';
 *
 * @example
 * var Float64Array = require( '@stdlib/array/float64' );
-* var ndarray2array = require( '@stdlib/ndarray/to-array' );
 * var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' );
 * var ndarray = require( '@stdlib/ndarray/base/ctor' );
 *
@@ -43,13 +42,10 @@ import { float64ndarray } from '@stdlib/types/ndarray';
 * var initial = scalar2ndarray( 0.0, 'float64', 'row-major' );
 *
 * var v = dcusumpw( [ x, y, initial ] );
-* // returns <ndarray>
+* // returns <ndarray>[ 1.0, 4.0, 8.0, 10.0 ]
 *
 * var bool = ( v === y );
 * // returns true
-*
-* var arr = ndarray2array( v );
-* // returns [ 1.0, 4.0, 8.0, 10.0 ]
 */
 declare function dcusumpw( arrays: [ float64ndarray, float64ndarray, float64ndarray ] ): float64ndarray;
 
diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcusumpw/lib/index.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcusumpw/lib/index.js
@@ -25,7 +25,6 @@
 *
 * @example
 * var Float64Array = require( '@stdlib/array/float64' );
-* var ndarray2array = require( '@stdlib/ndarray/to-array' );
 * var ndarray = require( '@stdlib/ndarray/base/ctor' );
 * var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' );
 * var dcusumpw = require( '@stdlib/blas/ext/base/ndarray/dcusumpw' );
@@ -39,13 +38,10 @@
 * var initial = scalar2ndarray( 0.0, 'float64', 'row-major' );
 *
 * var v = dcusumpw( [ x, y, initial ] );
-* // returns <ndarray>
+* // returns <ndarray>[ 1.0, 4.0, 8.0, 10.0 ]
 *
 * var bool = ( v === y );
 * // returns true
-*
-* var arr = ndarray2array( v );
-* // returns [ 1.0, 4.0, 8.0, 10.0 ]
 */
 
 // MODULES //
diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcusumpw/lib/main.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcusumpw/lib/main.js
@@ -38,7 +38,6 @@ var strided = require( '@stdlib/blas/ext/base/dcusumpw' ).ndarray;
 *
 * @example
 * var Float64Array = require( '@stdlib/array/float64' );
-* var ndarray2array = require( '@stdlib/ndarray/to-array' );
 * var ndarray = require( '@stdlib/ndarray/base/ctor' );
 * var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' );
 *
@@ -51,13 +50,10 @@ var strided = require( '@stdlib/blas/ext/base/dcusumpw' ).ndarray;
 * var initial = scalar2ndarray( 0.0, 'float64', 'row-major' );
 *
 * var v = dcusumpw( [ x, y, initial ] );
-* // returns <ndarray>
+* // returns <ndarray>[ 1.0, 4.0, 8.0, 10.0 ]
 *
 * var bool = ( v === y );
 * // returns true
-*
-* var arr = ndarray2array( v );
-* // returns [ 1.0, 4.0, 8.0, 10.0 ]
 */
 function dcusumpw( arrays ) {
 	var x = arrays[ 0 ];

Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,6 @@ import { float64ndarray } from '@stdlib/types/ndarray';`
`30`	`30`	`*`
`31`	`31`	`* @example`
`32`	`32`	`* var Float64Array = require( '@stdlib/array/float64' );`
`33`		`-* var ndarray2array = require( '@stdlib/ndarray/to-array' );`
`34`	`33`	`* var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' );`
`35`	`34`	`* var ndarray = require( '@stdlib/ndarray/base/ctor' );`
`36`	`35`	`*`
`@@ -43,13 +42,10 @@ import { float64ndarray } from '@stdlib/types/ndarray';`
`43`	`42`	`* var initial = scalar2ndarray( 0.0, 'float64', 'row-major' );`
`44`	`43`	`*`
`45`	`44`	`* var v = dcusumpw( [ x, y, initial ] );`
`46`		`-* // returns <ndarray>`
	`45`	`+* // returns <ndarray>[ 1.0, 4.0, 8.0, 10.0 ]`
`47`	`46`	`*`
`48`	`47`	`* var bool = ( v === y );`
`49`	`48`	`* // returns true`
`50`		`-*`
`51`		`-* var arr = ndarray2array( v );`
`52`		`-* // returns [ 1.0, 4.0, 8.0, 10.0 ]`
`53`	`49`	`*/`
`54`	`50`	`declare function dcusumpw( arrays: [ float64ndarray, float64ndarray, float64ndarray ] ): float64ndarray;`
`55`	`51`
Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,6 @@ var strided = require( '@stdlib/blas/ext/base/dcusumpw' ).ndarray;`
`38`	`38`	`*`
`39`	`39`	`* @example`
`40`	`40`	`* var Float64Array = require( '@stdlib/array/float64' );`
`41`		`-* var ndarray2array = require( '@stdlib/ndarray/to-array' );`
`42`	`41`	`* var ndarray = require( '@stdlib/ndarray/base/ctor' );`
`43`	`42`	`* var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' );`
`44`	`43`	`*`
`@@ -51,13 +50,10 @@ var strided = require( '@stdlib/blas/ext/base/dcusumpw' ).ndarray;`
`51`	`50`	`* var initial = scalar2ndarray( 0.0, 'float64', 'row-major' );`
`52`	`51`	`*`
`53`	`52`	`* var v = dcusumpw( [ x, y, initial ] );`
`54`		`-* // returns <ndarray>`
	`53`	`+* // returns <ndarray>[ 1.0, 4.0, 8.0, 10.0 ]`
`55`	`54`	`*`
`56`	`55`	`* var bool = ( v === y );`
`57`	`56`	`* // returns true`
`58`		`-*`
`59`		`-* var arr = ndarray2array( v );`
`60`		`-* // returns [ 1.0, 4.0, 8.0, 10.0 ]`
`61`	`57`	`*/`
`62`	`58`	`function dcusumpw( arrays ) {`
`63`	`59`	`var x = arrays[ 0 ];`