docs: minor clean-up

Planeshifter · Planeshifter · commit 5f73301a8509 · 2025-04-24T21:48:40.000-04: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: na
  - task: lint_typescript_tests
    status: na
  - task: lint_license_headers
    status: passed
---
diff --git a/lib/node_modules/@stdlib/array/base/accessors/README.md b/lib/node_modules/@stdlib/array/base/accessors/README.md
@@ -81,7 +81,7 @@ var fcns = obj.accessors;
     -   **idx**: element index.
     -   **value**: value to set.
 
--   The intent of this function is to provide a minimal abstraction over how elements are accessed when operating on indexed (i.e., array-like objects supporting element accesss via integer indices using bracket `[]` syntax) and accessor (i.e., array-like objects supporting the get/set protocol in which explicit `get` and `set` methods are used for element access) array-like objects.
+-   The intent of this function is to provide a minimal abstraction over how elements are accessed when operating on indexed (i.e., array-like objects supporting element access via integer indices using bracket `[]` syntax) and accessor (i.e., array-like objects supporting the get/set protocol in which explicit `get` and `set` methods are used for element access) array-like objects.
 
 </section>
 
diff --git a/lib/node_modules/@stdlib/array/base/at/README.md b/lib/node_modules/@stdlib/array/base/at/README.md
@@ -72,7 +72,7 @@ The function accepts the following arguments:
 
 ## Notes
 
--   If provided an array-like object having an `at` method , the function defers execution to that method and assumes that the method has the following signature:
+-   If provided an array-like object having an `at` method, the function defers execution to that method and assumes that the method has the following signature:
 
     ```text
     x.at( index )
diff --git a/lib/node_modules/@stdlib/array/base/cusome-by/README.md b/lib/node_modules/@stdlib/array/base/cusome-by/README.md
@@ -42,7 +42,7 @@ function fcn( value) {
 var x = [ 0, 0, 0, 1, 1 ];
 
 var y = cusomeBy( x, 2, fcn );
-// returns [ false, false, false , false, true ]
+// returns [ false, false, false, false, true ]
 ```
 
 The invoked `predicate` function is provided three arguments:
diff --git a/lib/node_modules/@stdlib/array/base/for-each/README.md b/lib/node_modules/@stdlib/array/base/for-each/README.md
@@ -20,7 +20,7 @@ limitations under the License.
 
 # forEach
 
-> Invoke a callback funcion once for each array element.
+> Invoke a callback function once for each array element.
 
 <!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
 
diff --git a/lib/node_modules/@stdlib/blas/base/cscal/README.md b/lib/node_modules/@stdlib/blas/base/cscal/README.md
@@ -127,7 +127,7 @@ cscal.ndarray( 2, ca, cx, 2, 1 );
 
 ## Notes
 
--   If `N <= 0` or `strideX <= 0` , both functions return `cx` unchanged.
+-   If `N <= 0` or `strideX <= 0`, both functions return `cx` unchanged.
 -   `cscal()` corresponds to the [BLAS][blas] level 1 function [`cscal`][cscal].
 
 </section>
diff --git a/lib/node_modules/@stdlib/blas/base/zscal/README.md b/lib/node_modules/@stdlib/blas/base/zscal/README.md
@@ -127,7 +127,7 @@ zscal.ndarray( 2, alpha, x, 2, 1 );
 
 ## Notes
 
--   If `N <= 0` , both functions return `x` unchanged.
+-   If `N <= 0`, both functions return `x` unchanged.
 -   `zscal()` corresponds to the [BLAS][blas] level 1 function [`zscal`][zscal].
 
 </section>
diff --git a/lib/node_modules/@stdlib/math/base/assert/is-composite/README.md b/lib/node_modules/@stdlib/math/base/assert/is-composite/README.md
@@ -149,7 +149,7 @@ bool stdlib_base_is_composite( const double x );
 #include <stdbool.h>
 
 int main( void ) {
-    const double x[] = { 0.0, 0.0/0.0, 1.0, -1.0 , 4.0 };
+    const double x[] = { 0.0, 0.0/0.0, 1.0, -1.0, 4.0 };
 
     bool r;
     int i;
diff --git a/lib/node_modules/@stdlib/math/base/special/nonfibonacci/README.md b/lib/node_modules/@stdlib/math/base/special/nonfibonacci/README.md
@@ -72,7 +72,7 @@ v = nonfibonacci( 3 );
 // returns 7
 ```
 
-If provided either a non-integer or `n < 1`, the function returns `NaN`. 
+If provided either a non-integer or `n < 1`, the function returns `NaN`.
 
 ```javascript
 var v = nonfibonacci( -1 );
@@ -195,7 +195,7 @@ int main( void ) {
     int i;
     for ( i = 1; i < 12; i++ ) {
         double result = stdlib_base_nonfibonacci( i );
-        printf( "x: %i => result: %lf", i , result );
+        printf( "x: %i => result: %lf", i, result );
     }
 }
 ```
diff --git a/lib/node_modules/@stdlib/math/base/special/nonfibonaccif/README.md b/lib/node_modules/@stdlib/math/base/special/nonfibonaccif/README.md
@@ -72,7 +72,7 @@ v = nonfibonaccif( 3 );
 // returns 7
 ```
 
-If provided either a non-integer or `n < 1`, the function returns `NaN`. 
+If provided either a non-integer or `n < 1`, the function returns `NaN`.
 
 ```javascript
 var v = nonfibonaccif( -1 );
@@ -190,9 +190,9 @@ float stdlib_base_nonfibonaccif( const int32_t x );
 
 int main( void ) {
     int i;
-    
+
     for ( i = 1; i < 12; i++ ) {
-        printf( "x: %i => result: %f", i , stdlib_base_nonfibonaccif( i ) );
+        printf( "x: %i => result: %f", i, stdlib_base_nonfibonaccif( i ) );
     }
 }
 ```
diff --git a/lib/node_modules/@stdlib/stats/base/dists/cosine/cdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/cosine/cdf/README.md
@@ -237,7 +237,7 @@ int main( void ) {
         mu = random_uniform( -50.0, 50.0 );
         s = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS, 20.0 );
         y = stdlib_base_dists_cosine_cdf( x, mu, s );
-        printf( "x: %lf, µ: %lf, s: %lf, F(x;µ,s): %lf\n", x, mu, s , y );
+        printf( "x: %lf, µ: %lf, s: %lf, F(x;µ,s): %lf\n", x, mu, s, y );
     }
 
     return 0;
diff --git a/lib/node_modules/@stdlib/stats/base/dists/cosine/kurtosis/README.md b/lib/node_modules/@stdlib/stats/base/dists/cosine/kurtosis/README.md
@@ -214,7 +214,7 @@ int main( void ) {
         mu = random_uniform( -50.0, 50.0 );
         s = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS, 20.0 );
         y = stdlib_base_dists_cosine_kurtosis( mu, s );
-        printf( "µ: %lf, s: %lf, Kurt(X;µ,s): %lf\n", mu, s , y );
+        printf( "µ: %lf, s: %lf, Kurt(X;µ,s): %lf\n", mu, s, y );
     }
 
     return 0;
diff --git a/lib/node_modules/@stdlib/stats/base/dists/cosine/logcdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/cosine/logcdf/README.md
@@ -247,7 +247,7 @@ int main( void ) {
         mu = random_uniform( -50.0, 50.0 );
         s = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS, 20.0 );
         y = stdlib_base_dists_cosine_logcdf( x, mu, s );
-        printf( "x: %lf, µ: %lf, s: %lf, ln(F(x;µ,s)): %lf\n", x, mu, s , y );
+        printf( "x: %lf, µ: %lf, s: %lf, ln(F(x;µ,s)): %lf\n", x, mu, s, y );
     }
 
     return 0;
diff --git a/lib/node_modules/@stdlib/stats/base/dists/cosine/logpdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/cosine/logpdf/README.md
@@ -238,7 +238,7 @@ int main( void ) {
         mu = random_uniform( -50.0, 50.0 );
         s = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS, 20.0 );
         y = stdlib_base_dists_cosine_logpdf( x, mu, s );
-        printf( "x: %lf, µ: %lf, s: %lf, ln(f(x;µ,s)): %lf\n", x, mu, s , y );
+        printf( "x: %lf, µ: %lf, s: %lf, ln(f(x;µ,s)): %lf\n", x, mu, s, y );
     }
 
     return 0;
diff --git a/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/README.md b/lib/node_modules/@stdlib/stats/base/dists/cosine/mean/README.md
@@ -213,7 +213,7 @@ int main( void ) {
         mu = random_uniform( -5.0, 5.0 );
         s = random_uniform( 0.0, 20.0 );
         y = stdlib_base_dists_cosine_mean( mu, s );
-        printf( "µ: %lf, s: %lf, E(X;µ,s): %lf\n", mu , s , y );
+        printf( "µ: %lf, s: %lf, E(X;µ,s): %lf\n", mu, s, y );
     }
 }
 ```
diff --git a/lib/node_modules/@stdlib/stats/base/dists/cosine/median/README.md b/lib/node_modules/@stdlib/stats/base/dists/cosine/median/README.md
@@ -214,7 +214,7 @@ int main( void ) {
         mu = random_uniform( -50.0, 50.0 );
         s = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS, 20.0 );
         y = stdlib_base_dists_cosine_median( mu, s );
-        printf( "µ: %lf, s: %lf, Median(X;µ,s): %lf\n", mu, s , y );
+        printf( "µ: %lf, s: %lf, Median(X;µ,s): %lf\n", mu, s, y );
     }
 
     return 0;
diff --git a/lib/node_modules/@stdlib/stats/base/dists/cosine/mgf/README.md b/lib/node_modules/@stdlib/stats/base/dists/cosine/mgf/README.md
@@ -221,7 +221,7 @@ int main( void ) {
         mu = random_uniform( -50.0, 50.0 );
         s = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS, 20.0 );
         y = stdlib_base_dists_cosine_mgf( t, mu, s );
-        printf( "t: %lf, µ: %lf, s: %lf, M_X(t;µ,s): %lf\n", t, mu, s , y );
+        printf( "t: %lf, µ: %lf, s: %lf, M_X(t;µ,s): %lf\n", t, mu, s, y );
     }
 
     return 0;
diff --git a/lib/node_modules/@stdlib/stats/base/dists/cosine/mode/README.md b/lib/node_modules/@stdlib/stats/base/dists/cosine/mode/README.md
@@ -214,7 +214,7 @@ int main( void ) {
         mu = random_uniform( -50.0, 50.0 );
         s = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS, 20.0 );
         y = stdlib_base_dists_cosine_mode( mu, s );
-        printf( "µ: %lf, s: %lf, mode(X;µ,s): %lf\n", mu, s , y );
+        printf( "µ: %lf, s: %lf, mode(X;µ,s): %lf\n", mu, s, y );
     }
 
     return 0;
diff --git a/lib/node_modules/@stdlib/stats/base/dists/cosine/pdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/cosine/pdf/README.md
@@ -228,7 +228,7 @@ int main( void ) {
         mu = random_uniform( -50.0, 50.0 );
         s = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS, 20.0 );
         y = stdlib_base_dists_cosine_pdf( x, mu, s );
-        printf( "x: %lf, µ: %lf, s: %lf, f(x;µ,s): %lf\n", x, mu, s , y );
+        printf( "x: %lf, µ: %lf, s: %lf, f(x;µ,s): %lf\n", x, mu, s, y );
     }
 
     return 0;
diff --git a/lib/node_modules/@stdlib/stats/base/dists/cosine/skewness/README.md b/lib/node_modules/@stdlib/stats/base/dists/cosine/skewness/README.md
@@ -214,7 +214,7 @@ int main( void ) {
         mu = random_uniform( -50.0, 50.0 );
         s = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS, 20.0 );
         y = stdlib_base_dists_cosine_skewness( mu, s );
-        printf( "µ: %lf, s: %lf, Skew(X;µ,s): %lf\n", mu, s , y );
+        printf( "µ: %lf, s: %lf, Skew(X;µ,s): %lf\n", mu, s, y );
     }
 
     return 0;
diff --git a/lib/node_modules/@stdlib/stats/base/dists/cosine/stdev/README.md b/lib/node_modules/@stdlib/stats/base/dists/cosine/stdev/README.md
@@ -214,7 +214,7 @@ int main( void ) {
         mu = random_uniform( -50.0, 50.0 );
         s = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS, 20.0 );
         y = stdlib_base_dists_cosine_stdev( mu, s );
-        printf( "µ: %lf, s: %lf, SD(X;µ,s): %lf\n", mu, s , y );
+        printf( "µ: %lf, s: %lf, SD(X;µ,s): %lf\n", mu, s, y );
     }
 
     return 0;
diff --git a/lib/node_modules/@stdlib/stats/base/dists/gamma/entropy/README.md b/lib/node_modules/@stdlib/stats/base/dists/gamma/entropy/README.md
@@ -227,7 +227,7 @@ int main( void ) {
         alpha = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS, 10.0 );
         beta = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS, 10.0 ) ;
         y = stdlib_base_dists_gamma_entropy( alpha, beta );
-        printf( "α: %1f. β: %1f. h(X;α,β): %lf\n", alpha , beta , y );
+        printf( "α: %1f, β: %1f, h(X;α,β): %lf\n", alpha, beta, y );
     }
 }
 ```
diff --git a/lib/node_modules/@stdlib/stats/base/dists/poisson/mean/README.md b/lib/node_modules/@stdlib/stats/base/dists/poisson/mean/README.md
@@ -171,7 +171,7 @@ double stdlib_base_dists_poisson_mean( const double lambda );
 
 <!-- /.usage -->
 
-<!-- C API usage notes. Make sure to keep an empty line after the `section` 
+<!-- C API usage notes. Make sure to keep an empty line after the `section`
 element and another before the `/section` close. -->
 
 <section class="notes">
@@ -199,7 +199,7 @@ int main( void ) {
     for ( i = 0; i < 10; i++ ) {
         lambda = 20.0 * (double)rand() / ( (double)RAND_MAX + 1.0 );
         v = stdlib_base_dists_poisson_mean( lambda );
-        printf( "λ: %lf , E(X;λ): %lf\n", lambda , v );
+        printf( "λ: %lf, E(X;λ): %lf\n", lambda, v );
     }
 }
 ```
diff --git a/lib/node_modules/@stdlib/stats/ranks/README.md b/lib/node_modules/@stdlib/stats/ranks/README.md
@@ -47,7 +47,7 @@ out = ranks( arr );
 // Missing values are placed last:
 arr = [ null, 2, 2, 1, 4, 3, NaN, NaN ];
 out = ranks( arr );
-// returns [ 6, 2.5, 2.5, 1, 5, 4, 7 ,8 ]
+// returns [ 6, 2.5, 2.5, 1, 5, 4, 7, 8 ]
 ```
 
 The function accepts the following options:
@@ -100,7 +100,7 @@ var out = ranks( data, {
 out = ranks( data, {
     'missing': 'last'
 });
-// returns [ 6, 2.5, 2.5, 1, 5, 4, 7 ,8 ]
+// returns [ 6, 2.5, 2.5, 1, 5, 4, 7, 8 ]
 
 out = ranks( data, {
     'missing': 'remove'
@@ -142,9 +142,9 @@ var out;
 var i;
 
 // Plain arrays...
-data = new Array( 10 );
+data = [];
 for ( i = 0; i < data.length; i++ ) {
-    data[ i ] = round( randu()*10.0 );
+    data.push( round( randu()*10.0 ) );
 }
 
 out = ranks( data );
diff --git a/lib/node_modules/@stdlib/stats/strided/dnanmaxabs/README.md b/lib/node_modules/@stdlib/stats/strided/dnanmaxabs/README.md
@@ -183,7 +183,7 @@ console.log( v );
 
 #### stdlib_strided_dnanmax( N, \*X, strideX )
 
-Computes the maximum absolute value of a double-precision floating-point strided array , ignoring `NaN` values.
+Computes the maximum absolute value of a double-precision floating-point strided array, ignoring `NaN` values.
 
 ```c
 const double x[] = { 1.0, -2.0, 0.0 / 0.0, -4.0 };
diff --git a/lib/node_modules/@stdlib/stats/strided/dsnanmeanpn/README.md b/lib/node_modules/@stdlib/stats/strided/dsnanmeanpn/README.md
@@ -204,7 +204,7 @@ console.log( v );
 
 #### stdlib_strided_dsnanmeanpn( N, \*X, strideX )
 
-Computes the arithmetic mean of a single-precision floating-point strided array , ignoring `NaN` values, using a two-pass error correction algorithm with extended accumulation, and returning an extended precision result.
+Computes the arithmetic mean of a single-precision floating-point strided array, ignoring `NaN` values, using a two-pass error correction algorithm with extended accumulation, and returning an extended precision result.
 
 ```c
 const float x[] = { 1.0f, 2.0f, 0.0f/0.0f, 3.0f, 0.0f/0.0f, 4.0f, 5.0f, 6.0f, 0.0f/0.0f, 7.0f, 8.0f, 0.0f/0.0f };
diff --git a/lib/node_modules/@stdlib/strided/base/read-dataview/README.md b/lib/node_modules/@stdlib/strided/base/read-dataview/README.md
@@ -66,7 +66,7 @@ The function accepts the following arguments:
 -   **strideOut**: index increment for `out`.
 -   **littleEndian**: boolean indicating whether to store values in little-endian format.
 
-The `N` and stride parameters determine which elements in `view` and `out` are accessed at runtime. For example, to index the first `N` elements of `view` in reverse order and to index every other value in `out` ,
+The `N` and stride parameters determine which elements in `view` and `out` are accessed at runtime. For example, to index the first `N` elements of `view` in reverse order and to index every other value in `out`,
 
 ```javascript
 var Float64Array = require( '@stdlib/array/float64' );
diff --git a/lib/node_modules/@stdlib/utils/every-own-by/README.md b/lib/node_modules/@stdlib/utils/every-own-by/README.md
@@ -124,8 +124,7 @@ var mean = context.sum / context.count;
 
 ## Notes
 
--   If the 1st argument is not an [`object`][mdn-object] or the second argument is not a fuction , the
-    function throws a Type Error.
+-   If the 1st argument is not an [`object`][mdn-object] or the second argument is not a fuction, the function throws a Type Error.
 
 -   If provided an empty object, the function returns `true`.
 
diff --git a/lib/node_modules/@stdlib/utils/none-in-by/README.md b/lib/node_modules/@stdlib/utils/none-in-by/README.md
@@ -123,7 +123,7 @@ var mean = context.sum / context.count;
 
 ## Notes
 
--   If the 1st argument is not an object or the second argument is not a fuction , the
+-   If the 1st argument is not an object or the second argument is not a fuction, the
     function throws a Type Error.
 
 -   If provided an empty object, the function returns `true`.
diff --git a/lib/node_modules/@stdlib/utils/none-own-by/README.md b/lib/node_modules/@stdlib/utils/none-own-by/README.md
@@ -86,7 +86,7 @@ var bool = noneOwnBy( obj, isUnderage );
 
 ## Notes
 
--   If the 1st argument is not an object or the second argument is not a fuction , the function throws a Type Error.
+-   If the 1st argument is not an object or the second argument is not a fuction, the function throws a Type Error.
 
 -   If provided an empty object, the function returns `true`.
 

Original file line number	Diff line number	Diff line change
`@@ -237,7 +237,7 @@ int main( void ) {`
`237`	`237`	`mu = random_uniform( -50.0, 50.0 );`
`238`	`238`	`s = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS, 20.0 );`
`239`	`239`	`y = stdlib_base_dists_cosine_cdf( x, mu, s );`
`240`		`- printf( "x: %lf, µ: %lf, s: %lf, F(x;µ,s): %lf\n", x, mu, s , y );`
	`240`	`+ printf( "x: %lf, µ: %lf, s: %lf, F(x;µ,s): %lf\n", x, mu, s, y );`
`241`	`241`	`}`
`242`	`242`
`243`	`243`	`return 0;`