docs: update blas/ext/base/dcusumkbn to follow current project conventions

PR-URL: #5167

Reviewed-by: Philipp Burckhardt <[email protected]>

Author: headlessNode

lib/node_modules/@stdlib/blas/ext/base/dcusumkbn/README.md

@@ -61,11 +61,11 @@ The function has the following parameters:
 -   **N**: number of indexed elements.
 -   **sum**: initial sum.
 -   **x**: input [`Float64Array`][@stdlib/array/float64].
--   **strideX**: index increment for `x`.
+-   **strideX**: stride length for `x`.
 -   **y**: output [`Float64Array`][@stdlib/array/float64].
--   **strideY**: index increment for `y`.
+-   **strideY**: stride length for `y`.
 
-The `N` and stride parameters determine which elements in the strided arrays are accessed at runtime. For example, to compute the cumulative sum of every other element in the strided input array,
+The `N` and stride parameters determine which elements in the strided arrays are accessed at runtime. For example, to compute the cumulative sum of every other element:
 
 ```javascript
 var Float64Array = require( '@stdlib/array/float64' );
@@ -115,7 +115,7 @@ The function has the following additional parameters:
 -   **offsetX**: starting index for `x`.
 -   **offsetY**: starting index for `y`.
 
-While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, offsetX and offsetY parameters support indexing semantics based on a starting indices. For example, to calculate the cumulative sum of every other value in the strided input array starting from the second value and to store in the last `N` elements of the strided output array starting from the last element
+While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameters support indexing semantics based on starting indices. For example, to calculate the cumulative sum of every other value in the strided input array starting from the second value and to store in the last `N` elements of the strided output array starting from the last element:
 
 ```javascript
 var Float64Array = require( '@stdlib/array/float64' );
@@ -210,9 +210,9 @@ The function accepts the following arguments:
 -   **N**: `[in] CBLAS_INT` number of indexed elements.
 -   **sum**: `[in] double` initial sum.
 -   **X**: `[in] double*` input array.
--   **strideX**: `[in] CBLAS_INT` index increment for `X`.
+-   **strideX**: `[in] CBLAS_INT` stride length for `X`.
 -   **Y**: `[out] double*` output array.
--   **strideY**: `[in] CBLAS_INT` index increment for `Y`.
+-   **strideY**: `[in] CBLAS_INT` stride length for `Y`.
 
 ```c
 void stdlib_strided_dcusumkbn( const CBLAS_INT N, const double sum, const double *X, const CBLAS_INT strideX, double *Y, const CBLAS_INT strideY );
@@ -238,10 +238,10 @@ The function accepts the following arguments:
 -   **N**: `[in] CBLAS_INT` number of indexed elements.
 -   **sum**: `[in] double` initial sum.
 -   **X**: `[in] double*` input array.
--   **strideX**: `[in] CBLAS_INT` index increment for `X`.
+-   **strideX**: `[in] CBLAS_INT` stride length for `X`.
 -   **offsetX**: `[in] CBLAS_INT` starting index for `X`.
 -   **Y**: `[out] double*` output array.
--   **strideY**: `[in] CBLAS_INT` index increment for `Y`.
+-   **strideY**: `[in] CBLAS_INT` stride length for `Y`.
 -   **offsetY**: `[in] CBLAS_INT` starting index for `Y`.
 
 ```c

lib/node_modules/@stdlib/blas/ext/base/dcusumkbn/docs/repl.txt

@@ -3,8 +3,8 @@
     Computes the cumulative sum of double-precision floating-point strided array
     elements using an improved Kahan–Babuška algorithm.
 
-    The `N` and stride parameters determine which elements in the strided
-    arrays are accessed at runtime.
+    The `N` and stride parameters determine which elements in the strided arrays
+    are accessed at runtime.
 
     Indexing is relative to the first index. To introduce an offset, use a typed
     array view.
@@ -23,13 +23,13 @@
         Input array.
 
     strideX: integer
-        Index increment for `x`.
+        Stride length for `x`.
 
     y: Float64Array
         Output array.
 
     strideY: integer
-        Index increment for `y`.
+        Stride length for `y`.
 
     Returns
     -------
@@ -44,7 +44,7 @@
     > {{alias}}( x.length, 0.0, x, 1, y, 1 )
     <Float64Array>[ 1.0, -1.0, 1.0 ]
 
-    // Using `N` and `stride` parameters:
+    // Using `N` and stride parameters:
     > x = new {{alias:@stdlib/array/float64}}( [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0 ] );
     > y = new {{alias:@stdlib/array/float64}}( x.length );
     > {{alias}}( 3, 0.0, x, 2, y, 2 )
@@ -67,8 +67,8 @@
     semantics.
 
     While typed array views mandate a view offset based on the underlying
-    buffer, the offset parameter supports indexing semantics based on a
-    starting index.
+    buffer, the offset parameters support indexing semantics based on starting
+    indices.
 
     Parameters
     ----------
@@ -82,7 +82,7 @@
         Input array.
 
     strideX: integer
-        Index increment for `x`.
+        Stride length for `x`.
 
     offsetX: integer
         Starting index for `x`.
@@ -91,7 +91,7 @@
         Output array.
 
     strideY: integer
-        Index increment for `y`.
+        Stride length for `y`.
 
     offsetY: integer
         Starting index for `y`.

lib/node_modules/@stdlib/blas/ext/base/dcusumkbn/docs/types/index.d.ts

@@ -28,9 +28,9 @@ interface Routine {
 	* @param N - number of indexed elements
 	* @param sum - initial sum
 	* @param x - input array
-	* @param strideX - `x` stride length
+	* @param strideX - stride length for `x`
 	* @param y - output array
-	* @param strideY - `y` stride length
+	* @param strideY - stride length for `y`
 	* @returns output array
 	*
 	* @example
@@ -50,10 +50,10 @@ interface Routine {
 	* @param N - number of indexed elements
 	* @param sum - initial sum
 	* @param x - input array
-	* @param strideX - `x` stride length
+	* @param strideX - stride length for `x`
 	* @param offsetX - starting index for `x`
 	* @param y - output array
-	* @param strideY - `y` stride length
+	* @param strideY - stride length for `y`
 	* @param offsetY - starting index for `y`
 	* @returns output array
 	*
@@ -75,9 +75,9 @@ interface Routine {
 * @param N - number of indexed elements
 * @param sum - initial sum
 * @param x - input array
-* @param strideX - `x` stride length
+* @param strideX - stride length for `x`
 * @param y - output array
-* @param strideY - `y` stride length
+* @param strideY - stride length for `y`
 * @returns output array
 *
 * @example

lib/node_modules/@stdlib/blas/ext/base/dcusumkbn/lib/dcusumkbn.js

@@ -40,9 +40,9 @@ var ndarray = require( './ndarray.js' );
 * @param {PositiveInteger} N - number of indexed elements
 * @param {number} sum - initial sum
 * @param {Float64Array} x - input array
-* @param {integer} strideX - `x` stride length
+* @param {integer} strideX - stride length for `x`
 * @param {Float64Array} y - output array
-* @param {integer} strideY - `y` stride length
+* @param {integer} strideY - stride length for `y`
 * @returns {Float64Array} output array
 *
 * @example

lib/node_modules/@stdlib/blas/ext/base/dcusumkbn/lib/dcusumkbn.native.js

@@ -31,9 +31,9 @@ var addon = require( './../src/addon.node' );
 * @param {PositiveInteger} N - number of indexed elements
 * @param {number} sum - initial sum
 * @param {Float64Array} x - input array
-* @param {integer} strideX - `x` stride length
+* @param {integer} strideX - stride length for `x`
 * @param {Float64Array} y - output array
-* @param {integer} strideY - `y` stride length
+* @param {integer} strideY - stride length for `y`
 * @returns {Float64Array} output array
 *
 * @example

lib/node_modules/@stdlib/blas/ext/base/dcusumkbn/lib/ndarray.js

@@ -39,10 +39,10 @@ var abs = require( '@stdlib/math/base/special/abs' );
 * @param {PositiveInteger} N - number of indexed elements
 * @param {number} sum - initial sum
 * @param {Float64Array} x - input array
-* @param {integer} strideX - `x` stride length
+* @param {integer} strideX - stride length for `x`
 * @param {NonNegativeInteger} offsetX - starting index for `x`
 * @param {Float64Array} y - output array
-* @param {integer} strideY - `y` stride length
+* @param {integer} strideY - stride length `y`
 * @param {NonNegativeInteger} offsetY - starting index for `y`
 * @returns {Float64Array} output array
 *

lib/node_modules/@stdlib/blas/ext/base/dcusumkbn/lib/ndarray.native.js

@@ -31,10 +31,10 @@ var addon = require( './../src/addon.node' );
 * @param {PositiveInteger} N - number of indexed elements
 * @param {number} sum - initial sum
 * @param {Float64Array} x - input array
-* @param {integer} strideX - `x` stride length
+* @param {integer} strideX - stride length for `x`
 * @param {NonNegativeInteger} offsetX - starting index for `x`
 * @param {Float64Array} y - output array
-* @param {integer} strideY - `y` stride length
+* @param {integer} strideY - stride length for `y`
 * @param {NonNegativeInteger} offsetY - starting index for `y`
 * @returns {Float64Array} output array
 *

lib/node_modules/@stdlib/blas/ext/base/dcusumkbn/src/main.c

@@ -35,9 +35,9 @@
 * @param N        number of indexed elements
 * @param sum      initial sum
 * @param X        input array
-* @param strideX  X stride length
+* @param strideX  stride length for X
 * @param Y        output array
-* @param strideY  Y stride length
+* @param strideY  stride length for Y
 */
 void API_SUFFIX(stdlib_strided_dcusumkbn)( const CBLAS_INT N, const double sum, const double *X, const CBLAS_INT strideX, double *Y, const CBLAS_INT strideY ) {
 	const CBLAS_INT ox = stdlib_strided_stride2offset( N, strideX );
@@ -59,11 +59,11 @@ void API_SUFFIX(stdlib_strided_dcusumkbn)( const CBLAS_INT N, const double sum,
 * @param N        number of indexed elements
 * @param sum      initial sum
 * @param X        input array
-* @param strideX  X index increment
-* @param offsetX  X starting index
+* @param strideX  stride length for X
+* @param offsetX  starting index for X
 * @param Y        output array
-* @param strideY  Y index increment
-* @param offsetY  Y starting index
+* @param strideY  stride length for Y
+* @param offsetY  starting index for Y
 */
 void API_SUFFIX(stdlib_strided_dcusumkbn_ndarray)( const CBLAS_INT N, const double sum, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, double *Y, const CBLAS_INT strideY, const CBLAS_INT offsetY ) {
 	CBLAS_INT ix;