docs: fix example code

Planeshifter · Planeshifter · commit cedc9bb0f92c · 2025-08-19T18:56:05.000-05:00
---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown
    status: na
  - task: lint_package_json
    status: na
  - task: lint_repl_help
    status: na
  - task: lint_javascript_src
    status: passed
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: na
  - task: lint_javascript_tests
    status: na
  - task: lint_javascript_benchmarks
    status: na
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: na
  - task: lint_typescript_tests
    status: na
  - task: lint_license_headers
    status: passed
---
diff --git a/lib/node_modules/@stdlib/array/base/cuevery-by/lib/index.js b/lib/node_modules/@stdlib/array/base/cuevery-by/lib/index.js
@@ -27,7 +27,7 @@
 * var cueveryBy = require( '@stdlib/array/base/cuevery-by' );
 *
 * function isPositive( value ) {
-*		return ( value > 0 );
+*     return ( value > 0 );
 * }
 *
 * var x = [ 1, 1, 1, 0, 1 ];
@@ -43,7 +43,7 @@
 * var out = cueveryBy.assign( x, y, 2, 0, isPositive );
 * // returns [ true, null, true, null, true, null, false, null, false, null ]
 *
-* var bool = ( arr === out );
+* var bool = ( y === out );
 * // returns true
 */
 
diff --git a/lib/node_modules/@stdlib/blas/base/ggemv/lib/index.js b/lib/node_modules/@stdlib/blas/base/ggemv/lib/index.js
@@ -41,7 +41,7 @@
 * var y = [ 1.0, 1.0 ];
 *
 * ggemv.ndarray( 'no-transpose', 2, 3, 1.0, A, 3, 1, 0, x, 1, 0, 1.0, y, 1, 0 );
-* // A => [ 2.0, 3.0, 4.0, 5.0, 6.0, 7.0 ]
+* // y => [ 7.0, 16.0 ]
 */
 
 // MODULES //
diff --git a/lib/node_modules/@stdlib/blas/base/sspr/lib/index.js b/lib/node_modules/@stdlib/blas/base/sspr/lib/index.js
@@ -40,7 +40,7 @@
 * var AP = new Float32Array( [ 1.0, 2.0, 3.0, 1.0, 2.0, 1.0 ] ); // => [ [ 1.0, 2.0, 3.0 ], [ 0.0, 1.0, 2.0 ], [ 0.0, 0.0, 1.0 ] ]
 * var x = new Float32Array( [ 1.0, 2.0, 3.0 ] );
 *
-* sspr.ndarray( 'row-major', 'upper', 3, 1.0, x, 1, AP );
+* sspr.ndarray( 'row-major', 'upper', 3, 1.0, x, 1, 0, AP, 1, 0 );
 * // AP => <Float32Array>[ 2.0, 4.0, 6.0, 5.0, 8.0, 10.0 ]
 */
 
diff --git a/lib/node_modules/@stdlib/blas/base/wasm/zcopy/lib/index.js b/lib/node_modules/@stdlib/blas/base/wasm/zcopy/lib/index.js
@@ -33,7 +33,7 @@
 *
 * // Perform operation:
 * zcopy.main( x.length, x, 1, y, 1 );
-// y => <Complex128Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
+* // y => <Complex128Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
 *
 * @example
 * var Complex128Array = require( '@stdlib/array/complex128' );
@@ -46,7 +46,7 @@
 *
 * // Perform operation:
 * zcopy.ndarray( x.length, x, 1, 0, y, 1, 0 );
-// y => <Complex128Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
+* // y => <Complex128Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
 *
 * @example
 * var Memory = require( '@stdlib/wasm/memory' );
@@ -100,7 +100,7 @@
 * mod.read( yptr, view );
 *
 * console.log( reinterpretComplex128( view, 0 ) );
-* // => <Float32Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0 ]
+* // => <Float64Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0 ]
 */
 
 // MODULES //
diff --git a/lib/node_modules/@stdlib/lapack/base/clacgv/lib/index.js b/lib/node_modules/@stdlib/lapack/base/clacgv/lib/index.js
@@ -50,7 +50,7 @@
 *
 * var cx = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
 *
-* clacgv.ndarray( 3, 1, 0 );
+* clacgv.ndarray( 3, cx, 1, 0 );
 *
 * var z = cx.get( 0 );
 * // returns <Complex64>
diff --git a/lib/node_modules/@stdlib/lapack/base/zlacgv/lib/index.js b/lib/node_modules/@stdlib/lapack/base/zlacgv/lib/index.js
@@ -50,7 +50,7 @@
 *
 * var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
 *
-* zlacgv.ndarray( 3, 1, 0 );
+* zlacgv.ndarray( 3, zx, 1, 0 );
 *
 * var z = zx.get( 0 );
 * // returns <Complex128>

Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@`
`27`	`27`	`* var cueveryBy = require( '@stdlib/array/base/cuevery-by' );`
`28`	`28`	`*`
`29`	`29`	`* function isPositive( value ) {`
`30`		`-* return ( value > 0 );`
	`30`	`+* return ( value > 0 );`
`31`	`31`	`* }`
`32`	`32`	`*`
`33`	`33`	`* var x = [ 1, 1, 1, 0, 1 ];`
`@@ -43,7 +43,7 @@`
`43`	`43`	`* var out = cueveryBy.assign( x, y, 2, 0, isPositive );`
`44`	`44`	`* // returns [ true, null, true, null, true, null, false, null, false, null ]`
`45`	`45`	`*`
`46`		`-* var bool = ( arr === out );`
	`46`	`+* var bool = ( y === out );`
`47`	`47`	`* // returns true`
`48`	`48`	`*/`
`49`	`49`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@`
`41`	`41`	`* var y = [ 1.0, 1.0 ];`
`42`	`42`	`*`
`43`	`43`	`* ggemv.ndarray( 'no-transpose', 2, 3, 1.0, A, 3, 1, 0, x, 1, 0, 1.0, y, 1, 0 );`
`44`		`-* // A => [ 2.0, 3.0, 4.0, 5.0, 6.0, 7.0 ]`
	`44`	`+* // y => [ 7.0, 16.0 ]`
`45`	`45`	`*/`
`46`	`46`
`47`	`47`	`// MODULES //`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@`
`40`	`40`	`* var AP = new Float32Array( [ 1.0, 2.0, 3.0, 1.0, 2.0, 1.0 ] ); // => [ [ 1.0, 2.0, 3.0 ], [ 0.0, 1.0, 2.0 ], [ 0.0, 0.0, 1.0 ] ]`
`41`	`41`	`* var x = new Float32Array( [ 1.0, 2.0, 3.0 ] );`
`42`	`42`	`*`
`43`		`-* sspr.ndarray( 'row-major', 'upper', 3, 1.0, x, 1, AP );`
	`43`	`+* sspr.ndarray( 'row-major', 'upper', 3, 1.0, x, 1, 0, AP, 1, 0 );`
`44`	`44`	`* // AP => <Float32Array>[ 2.0, 4.0, 6.0, 5.0, 8.0, 10.0 ]`
`45`	`45`	`*/`
`46`	`46`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@`
`33`	`33`	`*`
`34`	`34`	`* // Perform operation:`
`35`	`35`	`* zcopy.main( x.length, x, 1, y, 1 );`
`36`		`-// y => <Complex128Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]`
	`36`	`+* // y => <Complex128Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]`
`37`	`37`	`*`
`38`	`38`	`* @example`
`39`	`39`	`* var Complex128Array = require( '@stdlib/array/complex128' );`
`@@ -46,7 +46,7 @@`
`46`	`46`	`*`
`47`	`47`	`* // Perform operation:`
`48`	`48`	`* zcopy.ndarray( x.length, x, 1, 0, y, 1, 0 );`
`49`		`-// y => <Complex128Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]`
	`49`	`+* // y => <Complex128Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]`
`50`	`50`	`*`
`51`	`51`	`* @example`
`52`	`52`	`* var Memory = require( '@stdlib/wasm/memory' );`
`@@ -100,7 +100,7 @@`
`100`	`100`	`* mod.read( yptr, view );`
`101`	`101`	`*`
`102`	`102`	`* console.log( reinterpretComplex128( view, 0 ) );`
`103`		`-* // => <Float32Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0 ]`
	`103`	`+* // => <Float64Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0 ]`
`104`	`104`	`*/`
`105`	`105`
`106`	`106`	`// MODULES //`
Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,7 @@`
`50`	`50`	`*`
`51`	`51`	`* var cx = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );`
`52`	`52`	`*`
`53`		`-* clacgv.ndarray( 3, 1, 0 );`
	`53`	`+* clacgv.ndarray( 3, cx, 1, 0 );`
`54`	`54`	`*`
`55`	`55`	`* var z = cx.get( 0 );`
`56`	`56`	`* // returns <Complex64>`