docs: clean-up TSDoc examples

Planeshifter · Planeshifter · commit 82be305dfecc · 2025-09-10T15:17:18.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: na
  - 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: passed
  - task: lint_typescript_tests
    status: na
  - task: lint_license_headers
    status: passed
---
diff --git a/lib/node_modules/@stdlib/blas/base/dasum/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/base/dasum/docs/types/index.d.ts
@@ -74,7 +74,7 @@ interface Routine {
 * var x = new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] );
 *
 * var z = dasum( x.length, x, 1 );
-* // returns 15.0
+* // returns 21.0
 *
 * @example
 * var Float64Array = require( '@stdlib/array/float64' );
diff --git a/lib/node_modules/@stdlib/blas/base/gasum/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/base/gasum/docs/types/index.d.ts
@@ -57,7 +57,7 @@ interface Routine {
 	* @returns sum of absolute values
 	*
 	* @example
-	* var y = [ 2.0, 6.0, -1.0, -4.0, 8.0 ];
+	* var x = [ 2.0, 6.0, -1.0, -4.0, 8.0 ];
 	*
 	* var z = gasum.ndarray( x.length, x, 1, 0 );
 	* // returns 21.0
@@ -77,7 +77,7 @@ interface Routine {
 * var x = [ 2.0, 6.0, -1.0, -4.0, 8.0 ];
 *
 * var z = gasum( x.length, x, 1 );
-* // returns 15.0
+* // returns 21.0
 *
 * @example
 * var x = [ 2.0, 6.0, -1.0, -4.0, 8.0 ];
diff --git a/lib/node_modules/@stdlib/blas/base/sasum/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/base/sasum/docs/types/index.d.ts
@@ -74,7 +74,7 @@ interface Routine {
 * var x = new Float32Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] );
 *
 * var z = sasum( x.length, x, 1 );
-* // returns 15.0
+* // returns 21.0
 *
 * @example
 * var Float32Array = require( '@stdlib/array/float32' );
diff --git a/lib/node_modules/@stdlib/blas/ext/base/dnannsumkbn/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/dnannsumkbn/docs/types/index.d.ts
@@ -92,7 +92,7 @@ interface Routine {
 * var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] );
 * var out = new Float64Array( 2 );
 *
-* var v = dnannsumkbn( x.length, x, 1, 0, out, 1, 0 );
+* var v = dnannsumkbn.ndarray( x.length, x, 1, 0, out, 1, 0 );
 * // returns <Float64Array>[ 1.0, 3 ]
 */
 declare var dnannsumkbn: Routine;
diff --git a/lib/node_modules/@stdlib/blas/ext/base/dsnannsumors/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/dsnannsumors/docs/types/index.d.ts
@@ -96,7 +96,7 @@ interface Routine {
 * var x = new Float32Array( [ 1.0, -2.0, NaN, 2.0 ] );
 * var out = new Float64Array( 2 );
 *
-* var v = dsnannsumors( x.length, x, 1, 0, out, 1, 0 );
+* var v = dsnannsumors.ndarray( x.length, x, 1, 0, out, 1, 0 );
 * // returns <Float64Array>[ 1.0, 3 ]
 */
 declare var dsnannsumors: Routine;
diff --git a/lib/node_modules/@stdlib/blas/ext/base/gindex-of/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/gindex-of/docs/types/index.d.ts
@@ -45,7 +45,7 @@ interface Routine {
 	* @returns index
 	*
 	* @example
-	* var x = new [ 1.0, 2.0, 3.0, 4.0 ];
+	* var x = [ 1.0, 2.0, 3.0, 4.0 ];
 	*
 	* var idx = gindexOf( x.length, 2.0, x, 1 );
 	* // returns 1
diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsorthp/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gsorthp/docs/types/index.d.ts
@@ -47,7 +47,7 @@ import { typedndarray } from '@stdlib/types/ndarray';
 * var out = gsorthp( [ x, ord ] );
 * // returns <ndarray>
 *
-* var arr = ndarra2array( out );
+* var arr = ndarray2array( out );
 * // returns [ -4.0, -2.0, 1.0, 3.0 ]
 */
 declare function gsorthp<T = unknown>( arrays: [ typedndarray<T>, typedndarray<number> ] ): typedndarray<T>;
diff --git a/lib/node_modules/@stdlib/stats/array/mskmax/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/array/mskmax/docs/types/index.d.ts
@@ -41,9 +41,9 @@ type InputArray = NumericArray | Collection<number> | AccessorArrayLike<number>;
 * var v = mskmax( x, mask );
 * // returns 2.0
 */
-declare function max( x: InputArray, mask: InputArray ): number;
+declare function mskmax( x: InputArray, mask: InputArray ): number;
 
 
 // EXPORTS //
 
-export = max;
+export = mskmax;

Original file line number	Diff line number	Diff line change
`@@ -74,7 +74,7 @@ interface Routine {`
`74`	`74`	`* var x = new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] );`
`75`	`75`	`*`
`76`	`76`	`* var z = dasum( x.length, x, 1 );`
`77`		`-* // returns 15.0`
	`77`	`+* // returns 21.0`
`78`	`78`	`*`
`79`	`79`	`* @example`
`80`	`80`	`* var Float64Array = require( '@stdlib/array/float64' );`
Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,7 @@ interface Routine {`
`57`	`57`	`* @returns sum of absolute values`
`58`	`58`	`*`
`59`	`59`	`* @example`
`60`		`- * var y = [ 2.0, 6.0, -1.0, -4.0, 8.0 ];`
	`60`	`+ * var x = [ 2.0, 6.0, -1.0, -4.0, 8.0 ];`
`61`	`61`	`*`
`62`	`62`	`* var z = gasum.ndarray( x.length, x, 1, 0 );`
`63`	`63`	`* // returns 21.0`
`@@ -77,7 +77,7 @@ interface Routine {`
`77`	`77`	`* var x = [ 2.0, 6.0, -1.0, -4.0, 8.0 ];`
`78`	`78`	`*`
`79`	`79`	`* var z = gasum( x.length, x, 1 );`
`80`		`-* // returns 15.0`
	`80`	`+* // returns 21.0`
`81`	`81`	`*`
`82`	`82`	`* @example`
`83`	`83`	`* var x = [ 2.0, 6.0, -1.0, -4.0, 8.0 ];`
Original file line number	Diff line number	Diff line change
`@@ -92,7 +92,7 @@ interface Routine {`
`92`	`92`	`* var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] );`
`93`	`93`	`* var out = new Float64Array( 2 );`
`94`	`94`	`*`
`95`		`-* var v = dnannsumkbn( x.length, x, 1, 0, out, 1, 0 );`
	`95`	`+* var v = dnannsumkbn.ndarray( x.length, x, 1, 0, out, 1, 0 );`
`96`	`96`	`* // returns <Float64Array>[ 1.0, 3 ]`
`97`	`97`	`*/`
`98`	`98`	`declare var dnannsumkbn: Routine;`
Original file line number	Diff line number	Diff line change
`@@ -96,7 +96,7 @@ interface Routine {`
`96`	`96`	`* var x = new Float32Array( [ 1.0, -2.0, NaN, 2.0 ] );`
`97`	`97`	`* var out = new Float64Array( 2 );`
`98`	`98`	`*`
`99`		`-* var v = dsnannsumors( x.length, x, 1, 0, out, 1, 0 );`
	`99`	`+* var v = dsnannsumors.ndarray( x.length, x, 1, 0, out, 1, 0 );`
`100`	`100`	`* // returns <Float64Array>[ 1.0, 3 ]`
`101`	`101`	`*/`
`102`	`102`	`declare var dsnannsumors: Routine;`
Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ interface Routine {`
`45`	`45`	`* @returns index`
`46`	`46`	`*`
`47`	`47`	`* @example`
`48`		`- * var x = new [ 1.0, 2.0, 3.0, 4.0 ];`
	`48`	`+ * var x = [ 1.0, 2.0, 3.0, 4.0 ];`
`49`	`49`	`*`
`50`	`50`	`* var idx = gindexOf( x.length, 2.0, x, 1 );`
`51`	`51`	`* // returns 1`
Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ import { typedndarray } from '@stdlib/types/ndarray';`
`47`	`47`	`* var out = gsorthp( [ x, ord ] );`
`48`	`48`	`* // returns <ndarray>`
`49`	`49`	`*`
`50`		`-* var arr = ndarra2array( out );`
	`50`	`+* var arr = ndarray2array( out );`
`51`	`51`	`* // returns [ -4.0, -2.0, 1.0, 3.0 ]`
`52`	`52`	`*/`
`53`	`53`	`declare function gsorthp<T = unknown>( arrays: [ typedndarray<T>, typedndarray<number> ] ): typedndarray<T>;`