docs: fix TSDoc example annotations and remove unwanted parenthesis

Planeshifter · Planeshifter · commit 445837e40421 · 2025-11-18T11:26:05.000-06: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: passed
  - task: lint_license_headers
    status: passed
---
diff --git a/lib/node_modules/@stdlib/stats/base/cumax/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/cumax/docs/types/index.d.ts
@@ -95,7 +95,7 @@ interface Routine {
 * // y => [ 1.0, 1.0, 2.0 ]
 *
 * @example
-* var x = [ 1.0, -2.0, 2.0 ] );
+* var x = [ 1.0, -2.0, 2.0 ];
 * var y = [ 0.0, 0.0, 0.0 ];
 *
 * cumax.ndarray( x.length, x, 1, 0, y, 1, 0 );
diff --git a/lib/node_modules/@stdlib/stats/base/cumin/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/cumin/docs/types/index.d.ts
@@ -51,7 +51,7 @@ interface Routine {
 	* var y = [ 0.0, 0.0, 0.0 ];
 	*
 	* cumin( x.length, x, 1, y, 1 );
-	* // y => [ 1.0, 1.0, 2.0 ]
+	* // y => [ 1.0, -2.0, -2.0 ]
 	*/
 	<T extends OutputArray>( N: number, x: InputArray, strideX: number, y: T, strideY: number ): T;
 
@@ -72,7 +72,7 @@ interface Routine {
 	* var y = [ 0.0, 0.0, 0.0 ];
 	*
 	* cumin.ndarray( x.length, x, 1, 0, y, 1, 0 );
-	* // y => [ 1.0, 1.0, 2.0 ]
+	* // y => [ 1.0, -2.0, -2.0 ]
 	*/
 	ndarray<T extends OutputArray>( N: number, x: InputArray, strideX: number, offsetX: number, y: T, strideY: number, offsetY: number ): T;
 }
@@ -92,14 +92,14 @@ interface Routine {
 * var y = [ 0.0, 0.0, 0.0 ];
 *
 * cumin( x.length, x, 1, y, 1 );
-* // y => [ 1.0, 1.0, 2.0 ]
+* // y => [ 1.0, -2.0, -2.0 ]
 *
 * @example
-* var x = [ 1.0, -2.0, 2.0 ] );
+* var x = [ 1.0, -2.0, 2.0 ];
 * var y = [ 0.0, 0.0, 0.0 ];
 *
 * cumin.ndarray( x.length, x, 1, 0, y, 1, 0 );
-* // y => [ 1.0, 1.0, 2.0 ]
+* // y => [ 1.0, -2.0, -2.0 ]
 */
 declare var cumin: Routine;
 
diff --git a/lib/node_modules/@stdlib/stats/base/cuminabs/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/cuminabs/docs/types/index.d.ts
@@ -95,7 +95,7 @@ interface Routine {
 * // y => [ 1.0, 1.0, 1.0 ]
 *
 * @example
-* var x = [ 1.0, -2.0, 2.0 ] );
+* var x = [ 1.0, -2.0, 2.0 ];
 * var y = [ 0.0, 0.0, 0.0 ];
 *
 * cuminabs.ndarray( x.length, x, 1, 0, y, 1, 0 );

Original file line number	Diff line number	Diff line change
`@@ -95,7 +95,7 @@ interface Routine {`
`95`	`95`	`* // y => [ 1.0, 1.0, 2.0 ]`
`96`	`96`	`*`
`97`	`97`	`* @example`
`98`		`-* var x = [ 1.0, -2.0, 2.0 ] );`
	`98`	`+* var x = [ 1.0, -2.0, 2.0 ];`
`99`	`99`	`* var y = [ 0.0, 0.0, 0.0 ];`
`100`	`100`	`*`
`101`	`101`	`* cumax.ndarray( x.length, x, 1, 0, y, 1, 0 );`
Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,7 @@ interface Routine {`
`51`	`51`	`* var y = [ 0.0, 0.0, 0.0 ];`
`52`	`52`	`*`
`53`	`53`	`* cumin( x.length, x, 1, y, 1 );`
`54`		`- * // y => [ 1.0, 1.0, 2.0 ]`
	`54`	`+ * // y => [ 1.0, -2.0, -2.0 ]`
`55`	`55`	`*/`
`56`	`56`	`<T extends OutputArray>( N: number, x: InputArray, strideX: number, y: T, strideY: number ): T;`
`57`	`57`
`@@ -72,7 +72,7 @@ interface Routine {`
`72`	`72`	`* var y = [ 0.0, 0.0, 0.0 ];`
`73`	`73`	`*`
`74`	`74`	`* cumin.ndarray( x.length, x, 1, 0, y, 1, 0 );`
`75`		`- * // y => [ 1.0, 1.0, 2.0 ]`
	`75`	`+ * // y => [ 1.0, -2.0, -2.0 ]`
`76`	`76`	`*/`
`77`	`77`	`ndarray<T extends OutputArray>( N: number, x: InputArray, strideX: number, offsetX: number, y: T, strideY: number, offsetY: number ): T;`
`78`	`78`	`}`
`@@ -92,14 +92,14 @@ interface Routine {`
`92`	`92`	`* var y = [ 0.0, 0.0, 0.0 ];`
`93`	`93`	`*`
`94`	`94`	`* cumin( x.length, x, 1, y, 1 );`
`95`		`-* // y => [ 1.0, 1.0, 2.0 ]`
	`95`	`+* // y => [ 1.0, -2.0, -2.0 ]`
`96`	`96`	`*`
`97`	`97`	`* @example`
`98`		`-* var x = [ 1.0, -2.0, 2.0 ] );`
	`98`	`+* var x = [ 1.0, -2.0, 2.0 ];`
`99`	`99`	`* var y = [ 0.0, 0.0, 0.0 ];`
`100`	`100`	`*`
`101`	`101`	`* cumin.ndarray( x.length, x, 1, 0, y, 1, 0 );`
`102`		`-* // y => [ 1.0, 1.0, 2.0 ]`
	`102`	`+* // y => [ 1.0, -2.0, -2.0 ]`
`103`	`103`	`*/`
`104`	`104`	`declare var cumin: Routine;`
`105`	`105`