docs: minor clean-up

Planeshifter · Planeshifter · commit 721033eede9b · 2025-06-26T17:33:41.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: passed
  - 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/ext/base/gapxsum/README.md b/lib/node_modules/@stdlib/blas/ext/base/gapxsum/README.md
@@ -50,6 +50,7 @@ var v = gapxsum( x.length, 5.0, x, 1 );
 The function has the following parameters:
 
 -   **N**: number of indexed elements.
+-   **alpha**: scalar constant.
 -   **x**: input [`Array`][mdn-array] or [`typed array`][mdn-typed-array].
 -   **strideX**: stride length.
 
diff --git a/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/README.md b/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn/README.md
@@ -50,6 +50,7 @@ var v = gapxsumkbn( x.length, 5.0, x, 1 );
 The function has the following parameters:
 
 -   **N**: number of indexed elements.
+-   **alpha**: scalar constant.
 -   **x**: input [`Array`][mdn-array] or [`typed array`][mdn-typed-array].
 -   **strideX**: stride length.
 
diff --git a/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn2/README.md b/lib/node_modules/@stdlib/blas/ext/base/gapxsumkbn2/README.md
@@ -50,6 +50,7 @@ var v = gapxsumkbn2( x.length, 5.0, x, 1 );
 The function has the following parameters:
 
 -   **N**: number of indexed elements.
+-   **alpha**: scalar constant.
 -   **x**: input [`Array`][mdn-array] or [`typed array`][mdn-typed-array].
 -   **strideX**: stride length.
 
diff --git a/lib/node_modules/@stdlib/blas/ext/base/gapxsumors/README.md b/lib/node_modules/@stdlib/blas/ext/base/gapxsumors/README.md
@@ -50,6 +50,7 @@ var v = gapxsumors( x.length, 5.0, x, 1 );
 The function has the following parameters:
 
 -   **N**: number of indexed elements.
+-   **alpha**: scalar constant.
 -   **x**: input [`Array`][mdn-array] or [`typed array`][mdn-typed-array].
 -   **strideX**: stride length.
 
diff --git a/lib/node_modules/@stdlib/blas/ext/base/gapxsumpw/README.md b/lib/node_modules/@stdlib/blas/ext/base/gapxsumpw/README.md
@@ -50,6 +50,7 @@ var v = gapxsumpw( x.length, 5.0, x, 1 );
 The function has the following parameters:
 
 -   **N**: number of indexed elements.
+-   **alpha**: scalar constant.
 -   **x**: input [`Array`][mdn-array] or [`typed array`][mdn-typed-array].
 -   **strideX**: stride length.
 
diff --git a/lib/node_modules/@stdlib/blas/ext/base/grev/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/grev/docs/types/index.d.ts
@@ -43,7 +43,7 @@ interface Routine {
 	<T = unknown>( N: number, x: Collection<T>, strideX: number ): Collection<T>;
 
 	/**
-	* Reverses a strided array in-place. using alternative indexing semantics.
+	* Reverses a strided array in-place using alternative indexing semantics.
 	*
 	* @param N - number of indexed elements
 	* @param x - input array
diff --git a/lib/node_modules/@stdlib/blas/ext/base/gsortins/README.md b/lib/node_modules/@stdlib/blas/ext/base/gsortins/README.md
@@ -46,7 +46,7 @@ The function has the following parameters:
 -   **N**: number of indexed elements.
 -   **order**: sort order. If `order < 0.0`, the input strided array is sorted in **decreasing** order. If `order > 0.0`, the input strided array is sorted in **increasing** order. If `order == 0.0`, the input strided array is left unchanged.
 -   **x**: input [`Array`][mdn-array] or [`typed array`][mdn-typed-array].
--   **stride**: stride length.
+-   **strideX**: stride length.
 
 The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to sort every other element:
 
@@ -106,7 +106,7 @@ gsortins.ndarray( 3, 1.0, x, 1, x.length-3 );
 ## Notes
 
 -   If `N <= 0` or `order == 0.0`, both functions return `x` unchanged.
--   Both functions support array-like objects having getter and setter accessors for array element access (e.g., [`@stdlib/array/base/accessor`][@stdlib/array/base/accessor])
+-   Both functions support array-like objects having getter and setter accessors for array element access (e.g., [`@stdlib/array/base/accessor`][@stdlib/array/base/accessor]).
 -   The algorithm distinguishes between `-0` and `+0`. When sorted in increasing order, `-0` is sorted before `+0`. When sorted in decreasing order, `-0` is sorted after `+0`.
 -   The algorithm sorts `NaN` values to the end. When sorted in increasing order, `NaN` values are sorted last. When sorted in decreasing order, `NaN` values are sorted first.
 -   The algorithm has space complexity `O(1)` and worst case time complexity `O(N^2)`.
diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcusum/README.md b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcusum/README.md
@@ -50,7 +50,7 @@ var xbuf = new Float64Array( [ 1.0, 3.0, 4.0, 2.0 ] );
 var x = new ndarray( 'float64', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
 
 var ybuf = new Float64Array( [ 0.0, 0.0, 0.0, 0.0 ] );
-var y = new ndarray( 'float64', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
+var y = new ndarray( 'float64', ybuf, [ 4 ], [ 1 ], 0, 'row-major' );
 
 var initial = scalar2ndarray( 0.0, 'float64', 'row-major' );
 
diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/gcusum/README.md b/lib/node_modules/@stdlib/blas/ext/base/ndarray/gcusum/README.md
@@ -49,7 +49,7 @@ var xbuf = [ 1.0, 3.0, 4.0, 2.0 ];
 var x = new ndarray( 'generic', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
 
 var ybuf = [ 0.0, 0.0, 0.0, 0.0 ];
-var y = new ndarray( 'generic', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
+var y = new ndarray( 'generic', ybuf, [ 4 ], [ 1 ], 0, 'row-major' );
 
 var initial = scalar2ndarray( 0.0, 'generic', 'row-major' );
 
diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/scusum/README.md b/lib/node_modules/@stdlib/blas/ext/base/ndarray/scusum/README.md
@@ -50,7 +50,7 @@ var xbuf = new Float32Array( [ 1.0, 3.0, 4.0, 2.0 ] );
 var x = new ndarray( 'float32', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
 
 var ybuf = new Float32Array( [ 0.0, 0.0, 0.0, 0.0 ] );
-var y = new ndarray( 'float32', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
+var y = new ndarray( 'float32', ybuf, [ 4 ], [ 1 ], 0, 'row-major' );
 
 var initial = scalar2ndarray( 0.0, 'float32', 'row-major' );
 
diff --git a/lib/node_modules/@stdlib/blas/ext/base/sapxsumkbn2/README.md b/lib/node_modules/@stdlib/blas/ext/base/sapxsumkbn2/README.md
@@ -52,6 +52,7 @@ var v = sapxsumkbn2( x.length, 5.0, x, 1 );
 The function has the following parameters:
 
 -   **N**: number of indexed elements.
+-   **alpha**: scalar constant.
 -   **x**: input [`Float32Array`][@stdlib/array/float32].
 -   **strideX**: stride length.
 
diff --git a/lib/node_modules/@stdlib/blas/ext/base/sapxsumpw/README.md b/lib/node_modules/@stdlib/blas/ext/base/sapxsumpw/README.md
@@ -54,7 +54,7 @@ The function has the following parameters:
 -   **N**: number of indexed elements.
 -   **alpha**: scalar constant.
 -   **x**: input [`Float32Array`][@stdlib/array/float32].
--   **stride**: stride length.
+-   **strideX**: stride length.
 
 The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to access every other element:
 
diff --git a/lib/node_modules/@stdlib/blas/ext/base/sasumpw/README.md b/lib/node_modules/@stdlib/blas/ext/base/sasumpw/README.md
@@ -68,7 +68,7 @@ The function has the following parameters:
 
 -   **N**: number of indexed elements.
 -   **x**: input [`Float32Array`][@stdlib/array/float32].
--   **stride**: stride length.
+-   **strideX**: stride length.
 
 The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to compute the sum of absolute values of every other element:
 
@@ -192,7 +192,7 @@ console.log( v );
 Computes the sum of absolute values ([_L1_ norm][l1norm]) of single-precision floating-point strided array elements using pairwise summation.
 
 ```c
-const float x[] = { 1.0f, 2.0f, 3.0f, 4.0f }
+const float x[] = { 1.0f, 2.0f, 3.0f, 4.0f };
 
 float v = stdlib_strided_sasumpw( 4, x, 1 );
 // returns 10.0f
@@ -213,7 +213,7 @@ float stdlib_strided_sasumpw( const CBLAS_INT N, const float *X, const CBLAS_INT
 Computes the sum of absolute values ([_L1_ norm][l1norm]) of single-precision floating-point strided array elements using pairwise summation and alternative indexing semantics.
 
 ```c
-const float x[] = { 1.0f, 2.0f, 3.0f, 4.0f }
+const float x[] = { 1.0f, 2.0f, 3.0f, 4.0f };
 
 float v = stdlib_strided_sasumpw_ndarray( 4, x, 1, 0 );
 // returns 10.0f
diff --git a/lib/node_modules/@stdlib/blas/ext/base/scusumkbn2/README.md b/lib/node_modules/@stdlib/blas/ext/base/scusumkbn2/README.md
@@ -200,8 +200,8 @@ console.log( y );
 Computes the cumulative sum of single-precision floating-point strided array elements using a second-order iterative Kahan–Babuška algorithm.
 
 ```c
-const float x[] = { 1.0f, 2.0f, 3.0f, 4.0f }
-float y[] = { 0.0f, 0.0f, 0.0f, 0.0f }
+const float x[] = { 1.0f, 2.0f, 3.0f, 4.0f };
+float y[] = { 0.0f, 0.0f, 0.0f, 0.0f };
 
 stdlib_strided_scusumkbn2( 4, 0.0f, x, 1, y, 1 );
 ```
@@ -228,8 +228,8 @@ void stdlib_strided_scusumkbn2( const CBLAS_INT N, const float sum, const float
 Computes the cumulative sum of single-precision floating-point strided array elements using a second-order iterative Kahan–Babuška algorithm and alternative indexing semantics.
 
 ```c
-const float x[] = { 1.0f, 2.0f, 3.0f, 4.0f }
-float y[] = { 0.0f, 0.0f, 0.0f, 0.0f }
+const float x[] = { 1.0f, 2.0f, 3.0f, 4.0f };
+float y[] = { 0.0f, 0.0f, 0.0f, 0.0f };
 
 stdlib_strided_scusumkbn2_ndarray( 4, 0.0f, x, 1, 0, y, 1, 0 );
 ```
diff --git a/lib/node_modules/@stdlib/blas/ext/base/scusumors/README.md b/lib/node_modules/@stdlib/blas/ext/base/scusumors/README.md
@@ -201,8 +201,8 @@ console.log( y );
 Computes the cumulative sum of single-precision floating-point strided array elements using ordinary recursive summation.
 
 ```c
-const float x[] = { 1.0f, 2.0f, 3.0f, 4.0f }
-float y[] = { 0.0f, 0.0f, 0.0f, 0.0f }
+const float x[] = { 1.0f, 2.0f, 3.0f, 4.0f };
+float y[] = { 0.0f, 0.0f, 0.0f, 0.0f };
 
 stdlib_strided_scusumors( 4, 0.0f, x, 1, y, 1 );
 ```
@@ -229,8 +229,8 @@ void stdlib_strided_scusumors( const CBLAS_INT N, const float sum, const float *
 Computes the cumulative sum of single-precision floating-point strided array elements using ordinary recursive summation and alternative indexing semantics.
 
 ```c
-const float x[] = { 1.0f, 2.0f, 3.0f, 4.0f }
-float y[] = { 0.0f, 0.0f, 0.0f, 0.0f }
+const float x[] = { 1.0f, 2.0f, 3.0f, 4.0f };
+float y[] = { 0.0f, 0.0f, 0.0f, 0.0f };
 
 stdlib_strided_scusumors_ndarray( 4, 0.0f, x, 1, 0, y, 1, 0 );
 ```
diff --git a/lib/node_modules/@stdlib/blas/ext/base/scusumpw/README.md b/lib/node_modules/@stdlib/blas/ext/base/scusumpw/README.md
@@ -201,8 +201,8 @@ console.log( y );
 Computes the cumulative sum of single-precision floating-point strided array elements using pairwise summation.
 
 ```c
-const float x[] = { 1.0f, 2.0f, 3.0f, 4.0f }
-float y[] = { 0.0f, 0.0f, 0.0f, 0.0f }
+const float x[] = { 1.0f, 2.0f, 3.0f, 4.0f };
+float y[] = { 0.0f, 0.0f, 0.0f, 0.0f };
 
 stdlib_strided_scusumpw( 4, 0.0f, x, 1, y, 1 );
 ```
@@ -229,8 +229,8 @@ void stdlib_strided_scusumpw( const CBLAS_INT N, const float sum, const float *X
 Computes the cumulative sum of single-precision floating-point strided array elements using pairwise summation and alternative indexing semantics.
 
 ```c
-const float x[] = { 1.0f, 2.0f, 3.0f, 4.0f }
-float y[] = { 0.0f, 0.0f, 0.0f, 0.0f }
+const float x[] = { 1.0f, 2.0f, 3.0f, 4.0f };
+float y[] = { 0.0f, 0.0f, 0.0f, 0.0f };
 
 stdlib_strided_scusumpw_ndarray( 4, 0.0f, x, 1, 0, y, 1, 0 );
 ```

Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@ interface Routine {`
`43`	`43`	`<T = unknown>( N: number, x: Collection<T>, strideX: number ): Collection<T>;`
`44`	`44`
`45`	`45`	`/**`
`46`		`- * Reverses a strided array in-place. using alternative indexing semantics.`
	`46`	`+ * Reverses a strided array in-place using alternative indexing semantics.`
`47`	`47`	`*`
`48`	`48`	`* @param N - number of indexed elements`
`49`	`49`	`* @param x - input array`