docs: minor clean-up

Planeshifter · Planeshifter · commit 4dba421f5bd8 · 2025-06-25T20:01:58.000-05:00
diff --git a/lib/node_modules/@stdlib/blas/base/csrot/README.md b/lib/node_modules/@stdlib/blas/base/csrot/README.md
@@ -283,7 +283,7 @@ int main( void ) {
     const int strideX = 1;
     const int strideY = -1;
 
-    // Copy elements:
+    // Apply a plane rotation:
     c_csrot( N, (void *)x, strideX, (void *)y, strideY, 0.8f, 0.6f );
 
     // Print the result:
diff --git a/lib/node_modules/@stdlib/blas/base/dnrm2/README.md b/lib/node_modules/@stdlib/blas/base/dnrm2/README.md
@@ -26,7 +26,7 @@ limitations under the License.
 
 The [L2-norm][l2-norm] is defined as
 
-<!-- <equation class="equation" label="eq:l2_norm" align="center raw="\|\mathbf{x}\|_2 = \sqrt{x_0^2 + x_1^2 + \ldots + x_{N-1}^2}" alt="L2-norm definition."> -->
+<!-- <equation class="equation" label="eq:l2_norm" align="center" raw="\|\mathbf{x}\|_2 = \sqrt{x_0^2 + x_1^2 + \ldots + x_{N-1}^2}" alt="L2-norm definition."> -->
 
 <div class="equation" align="center" data-raw-text="\|\mathbf{x}\|_2 = \sqrt{x_0^2 + x_1^2 + \ldots + x_{N-1}^2}" data-equation="eq:l2_norm">
     <img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@f766d7eeb56ff14cbceeeeef03d7f7b88c467515/lib/node_modules/@stdlib/blas/base/dnrm2/docs/img/equation_l2_norm.svg" alt="L2-norm definition.">
diff --git a/lib/node_modules/@stdlib/blas/base/gnrm2/README.md b/lib/node_modules/@stdlib/blas/base/gnrm2/README.md
@@ -26,7 +26,7 @@ limitations under the License.
 
 The [L2-norm][l2-norm] is defined as
 
-<!-- <equation class="equation" label="eq:l2_norm" align="center raw="\|\mathbf{x}\|_2 = \sqrt{x_0^2 + x_1^2 + \ldots + x_{N-1}^2}" alt="L2-norm definition."> -->
+<!-- <equation class="equation" label="eq:l2_norm" align="center" raw="\|\mathbf{x}\|_2 = \sqrt{x_0^2 + x_1^2 + \ldots + x_{N-1}^2}" alt="L2-norm definition."> -->
 
 <div class="equation" align="center" data-raw-text="\|\mathbf{x}\|_2 = \sqrt{x_0^2 + x_1^2 + \ldots + x_{N-1}^2}" data-equation="eq:l2_norm">
     <img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@f8997c489e47eb1a9d993ef4ab3a522a095331f5/lib/node_modules/@stdlib/blas/base/gnrm2/docs/img/equation_l2_norm.svg" alt="L2-norm definition.">
diff --git a/lib/node_modules/@stdlib/blas/base/operation-side-resolve-str/README.md b/lib/node_modules/@stdlib/blas/base/operation-side-resolve-str/README.md
@@ -54,7 +54,7 @@ v = resolve( str2enum( 'left' ) );
 // returns 'left'
 ```
 
-If unable to resolve a operation side string, the function returns `null`.
+If unable to resolve an operation side string, the function returns `null`.
 
 ```javascript
 var v = resolve( 'beep' );
diff --git a/lib/node_modules/@stdlib/blas/base/operation-sides/README.md b/lib/node_modules/@stdlib/blas/base/operation-sides/README.md
@@ -124,7 +124,7 @@ bool = isOperationSide( 'beep' );
 
 An enumeration of BLAS operation sides with the following fields:
 
--   **STDLIB_BLAS_LEFT**: a triangular matrix is on the left side of a matrix-matrix operation (e.g., `XA = B`, where `A` is a triangular matrix).
+-   **STDLIB_BLAS_LEFT**: a triangular matrix is on the left side of a matrix-matrix operation (e.g., `AX = B`, where `A` is a triangular matrix).
 -   **STDLIB_BLAS_RIGHT**: a triangular matrix is on the right side of a matrix-matrix operation (e.g., `XA = B`, where `A` is a triangular matrix).
 
 ```c
diff --git a/lib/node_modules/@stdlib/blas/base/saxpy/README.md b/lib/node_modules/@stdlib/blas/base/saxpy/README.md
@@ -207,7 +207,7 @@ The function accepts the following arguments:
 -   **X**: `[in] float*` input array.
 -   **strideX**: `[in] CBLAS_INT` index increment for `X`.
 -   **Y**: `[inout] float*` output array.
--   **strideY**: `[in CBLAS_INT` index increment for `Y`.
+-   **strideY**: `[in] CBLAS_INT` index increment for `Y`.
 
 ```c
 void c_saxpy( const CBLAS_INT N, const float alpha, const float *X, const CBLAS_INT strideX, float *Y, const CBLAS_INT strideY );
@@ -232,7 +232,7 @@ The function accepts the following arguments:
 -   **strideX**: `[in] CBLAS_INT` index increment for `X`.
 -   **offsetX**: `[in] CBLAS_INT` starting index for `X`.
 -   **Y**: `[inout] float*` output array.
--   **strideY**: `[in CBLAS_INT` index increment for `Y`.
+-   **strideY**: `[in] CBLAS_INT` index increment for `Y`.
 -   **offsetY**: `[in] CBLAS_INT` starting index for `Y`.
 
 ```c
diff --git a/lib/node_modules/@stdlib/blas/base/scasum/README.md b/lib/node_modules/@stdlib/blas/base/scasum/README.md
@@ -71,7 +71,7 @@ var x0 = new Complex64Array( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ] );
 // Create an offset view:
 var x1 = new Complex64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
 
-// Compute the L2-out:
+// Compute the sum of absolute values:
 var out = scasum( 2, x1, 1 );
 // returns 18.0
 ```
diff --git a/lib/node_modules/@stdlib/blas/base/scnrm2/README.md b/lib/node_modules/@stdlib/blas/base/scnrm2/README.md
@@ -210,6 +210,7 @@ The function accepts the following arguments:
 -   **N**: `[in] CBLAS_INT` number of indexed elements.
 -   **X**: `[in] void*` input array.
 -   **strideX**: `[in] CBLAS_INT` index increment for `X`.
+-   **offsetX**: `[in] CBLAS_INT` starting index for `X`.
 
 ```c
 float c_scnrm2_ndarray( const CBLAS_INT N, const void *X, const CBLAS_INT strideX, const CBLAS_INT offsetX );
diff --git a/lib/node_modules/@stdlib/blas/base/snrm2/README.md b/lib/node_modules/@stdlib/blas/base/snrm2/README.md
@@ -26,7 +26,7 @@ limitations under the License.
 
 The [L2-norm][l2-norm] is defined as
 
-<!-- <equation class="equation" label="eq:l2_norm" align="center raw="\|\mathbf{x}\|_2 = \sqrt{x_0^2 + x_1^2 + \ldots + x_{N-1}^2}" alt="L2-norm definition."> -->
+<!-- <equation class="equation" label="eq:l2_norm" align="center" raw="\|\mathbf{x}\|_2 = \sqrt{x_0^2 + x_1^2 + \ldots + x_{N-1}^2}" alt="L2-norm definition."> -->
 
 <div class="equation" align="center" data-raw-text="\|\mathbf{x}\|_2 = \sqrt{x_0^2 + x_1^2 + \ldots + x_{N-1}^2}" data-equation="eq:l2_norm">
     <img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@247c6b352fc1002f11ba3e7ed389f067380a8a87/lib/node_modules/@stdlib/blas/base/snrm2/docs/img/equation_l2_norm.svg" alt="L2-norm definition.">
@@ -188,7 +188,7 @@ console.log( out );
 
 #### c_snrm2( N, \*X, stride )
 
-Computes the L2-norm of a complex single-precision floating-point vector.
+Computes the L2-norm of a single-precision floating-point vector.
 
 ```c
 const float x[] = { 1.0f, 2.0f, 2.0f, -7.0f, -2.0f, 3.0f, 4.0f, 2.0f };
@@ -209,7 +209,7 @@ float c_snrm2( const CBLAS_INT N, const float *X, const CBLAS_INT stride );
 
 #### c_snrm2_ndarray( N, \*X, stride, offset )
 
-Computes the L2-norm of a complex single-precision floating-point vector using alternative indexing semantics.
+Computes the L2-norm of a single-precision floating-point vector using alternative indexing semantics.
 
 ```c
 const float x[] = { 1.0f, 2.0f, 2.0f, -7.0f, -2.0f, 3.0f, 4.0f, 2.0f };
diff --git a/lib/node_modules/@stdlib/blas/base/srot/README.md b/lib/node_modules/@stdlib/blas/base/srot/README.md
@@ -69,7 +69,7 @@ The function has the following parameters:
 -   **c**: cosine of the angle of rotation.
 -   **s**: sine of the angle of rotation.
 
-The `N` and stride parameters determine how values in the strided arrays are accessed at runtime. For example, to apply a plane rotation to every other element, 
+The `N` and stride parameters determine how values in the strided arrays are accessed at runtime. For example, to apply a plane rotation to every other element,
 
 ```javascript
 var Float32Array = require( '@stdlib/array/float32' );
@@ -169,7 +169,7 @@ console.log( x );
 var y = discreteUniform( x.length, 0, 255, opts );
 console.log( y );
 
-// Applies a plane rotation :
+// Apply a plane rotation:
 srot( x.length, x, 1, y, 1, 0.8, 0.6 );
 console.log( x );
 console.log( y );
diff --git a/lib/node_modules/@stdlib/blas/base/sspr/README.md b/lib/node_modules/@stdlib/blas/base/sspr/README.md
@@ -213,7 +213,7 @@ The function accepts the following arguments:
 void c_sspr( const CBLAS_LAYOUT order, const CBLAS_UPLO uplo, const CBLAS_INT N, const float alpha, const float *X, const CBLAS_INT strideX, float *AP )
 ```
 
-#### c_sspr_ndarray( order, uplo, N, alpha, \*X, strideX, \*AP, strideAP, offsetAP )
+#### c_sspr_ndarray( order, uplo, N, alpha, \*X, strideX, offsetX, \*AP, strideAP, offsetAP )
 
 Performs the symmetric rank 1 operation `A = α*x*x^T + A` where `α` is a scalar, `x` is an `N` element vector, and `A` is an `N` by `N` symmetric matrix supplied in packed form using alternative indexing semantics.
 
@@ -234,6 +234,7 @@ The function accepts the following arguments:
 -   **alpha**: `[in] float` scalar.
 -   **X**: `[in] float*` input vector.
 -   **strideX**: `[in] CBLAS_INT` stride length for `X`.
+-   **offsetX**: `[in] CBLAS_INT` starting index for `X`.
 -   **AP**: `[inout] float*` packed form of a symmetric matrix `A`.
 -   **strideAP**: `[in] CBLAS_INT` stride length for `AP`.
 -   **offsetAP**: `[in] CBLAS_INT` starting index for `AP`.
diff --git a/lib/node_modules/@stdlib/blas/base/sswap/README.md b/lib/node_modules/@stdlib/blas/base/sswap/README.md
@@ -235,7 +235,7 @@ The function accepts the following arguments:
 -   **offsetY**: `[in] CBLAS_INT` starting index for `Y`.
 
 ```c
-void c_sswap_ndarray( const CBLAS_INT N, float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, float *Y, const CBLAS_INT strideY, CBLAS_INT offsetY );
+void c_sswap_ndarray( const CBLAS_INT N, float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, float *Y, const CBLAS_INT strideY, const CBLAS_INT offsetY );
 ```
 
 </section>
diff --git a/lib/node_modules/@stdlib/blas/base/strsv/README.md b/lib/node_modules/@stdlib/blas/base/strsv/README.md
@@ -52,7 +52,7 @@ The function has the following parameters:
 -   **diag**: specifies whether `A` has a unit diagonal.
 -   **N**: number of elements along each dimension of `A`.
 -   **A**: input matrix stored in linear memory as a [`Float32Array`][mdn-float32array].
--   **lda**: stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`).
+-   **LDA**: stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`).
 -   **x**: input vector [`Float32Array`][mdn-float32array].
 -   **sx**: `x` stride length.
 
diff --git a/lib/node_modules/@stdlib/blas/base/wasm/scopy/README.md b/lib/node_modules/@stdlib/blas/base/wasm/scopy/README.md
@@ -49,7 +49,7 @@ The function has the following parameters:
 -   **N**: number of indexed elements.
 -   **x**: input [`Float32Array`][@stdlib/array/float32].
 -   **strideX**: index increment for `x`.
--   **y**: input [`Float32Array`][@stdlib/array/float32].
+-   **y**: output [`Float32Array`][@stdlib/array/float32].
 -   **strideY**: index increment for `y`.
 
 The `N` and stride parameters determine which elements in the strided arrays are accessed at runtime. For example, to copy every other element from `x` into `y` in reverse order,
