chore: resolve lint errors and fix typos

Planeshifter · Planeshifter · commit 4c5b60e5137f · 2024-05-06T16:27:11.000-04:00
diff --git a/lib/node_modules/@stdlib/bench/harness/lib/utils/next_tick.js b/lib/node_modules/@stdlib/bench/harness/lib/utils/next_tick.js
@@ -31,7 +31,6 @@
 * -   Only API which is universal is `setTimeout`.
 * -   Note that `0` is not actually `0ms`. Browser environments commonly have a minimum delay of `4ms`. This is acceptable. Here, the main intent of this function is to give the runtime a chance to run garbage collection, clear state, and tend to any other pending tasks before returning control to benchmark tasks. The larger aim (attainable or not) is to provide each benchmark run with as much of a fresh state as possible.
 *
-*
 * @private
 * @param {Function} fcn - function to run upon a subsequent turn of the event loop
 */
diff --git a/lib/node_modules/@stdlib/math/base/special/ellipj/lib/assign.js b/lib/node_modules/@stdlib/math/base/special/ellipj/lib/assign.js
@@ -59,23 +59,23 @@ var ca = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];
 * @returns {Collection} output array
 *
 * @example
-* var v = ellipj( 0.3, 0.5, [ 0.0, 0.0, 0.0, 0.0 ], 1, 0 );
+* var v = assign( 0.3, 0.5, [ 0.0, 0.0, 0.0, 0.0 ], 1, 0 );
 * // returns [ ~0.293, ~0.956, ~0.978, ~0.298 ]
 *
 * @example
-* v = ellipj( 0.0, 0.0, [ 0.0, 0.0, 0.0, 0.0 ], 1, 0 );
+* v = assign( 0.0, 0.0, [ 0.0, 0.0, 0.0, 0.0 ], 1, 0 );
 * // returns [ ~0.0, ~1.0, ~1.0, ~0.0 ]
 *
 * @example
-* v = ellipj( Infinity, 1.0, [ 0.0, 0.0, 0.0, 0.0 ], 1, 0 );
+* v = assign( Infinity, 1.0, [ 0.0, 0.0, 0.0, 0.0 ], 1, 0 );
 * // returns [ ~1.0, ~0.0, ~0.0, ~1.571 ]
 *
 * @example
-* v = ellipj( 0.0, -2.0, [ 0.0, 0.0, 0.0, 0.0 ], 1, 0 );
+* v = assign( 0.0, -2.0, [ 0.0, 0.0, 0.0, 0.0 ], 1, 0 );
 * // returns [ ~0.0, ~1.0, ~1.0, NaN ]
 *
 * @example
-* v = ellipj( NaN, NaN, [ 0.0, 0.0, 0.0, 0.0 ], 1, 0 );
+* v = assign( NaN, NaN, [ 0.0, 0.0, 0.0, 0.0 ], 1, 0 );
 * // returns [ NaN, NaN, NaN, NaN ]
 */
 function assign(u, m, out, stride, offset) {
diff --git a/lib/node_modules/@stdlib/math/base/special/falling-factorial/lib/main.js b/lib/node_modules/@stdlib/math/base/special/falling-factorial/lib/main.js
@@ -67,6 +67,7 @@ var MAX_FACTORIAL = 170; // TODO: consider packaging as constant
 *     \operatorname{risingFactorial}(x, n) = \frac{ \Gamma(x + n) }{ \Gamma(x) };
 *     ```
 *
+* @private
 * @param {number} x - first function parameter
 * @param {integer} n - second function parameter
 * @returns {number} function value
diff --git a/lib/node_modules/@stdlib/stats/incr/grubbs/lib/validate.js b/lib/node_modules/@stdlib/stats/incr/grubbs/lib/validate.js
@@ -47,7 +47,7 @@ var isnan = require( '@stdlib/assert/is-nan' );
 *
 * var options = {
 *     'alpha': 0.05,
-*     'alernative': 'two-sided',
+*     'alternative': 'two-sided',
 *     'init': 100
 * };
 *
diff --git a/lib/node_modules/@stdlib/stats/incr/mgrubbs/lib/validate.js b/lib/node_modules/@stdlib/stats/incr/mgrubbs/lib/validate.js
@@ -45,7 +45,7 @@ var isnan = require( '@stdlib/assert/is-nan' );
 *
 * var options = {
 *     'alpha': 0.05,
-*     'alernative': 'two-sided'
+*     'alternative': 'two-sided'
 * };
 *
 * var err = validate( opts, options );
diff --git a/lib/node_modules/@stdlib/stats/incr/mprod/lib/main.js b/lib/node_modules/@stdlib/stats/incr/mprod/lib/main.js
@@ -126,7 +126,7 @@ function incrmprod( W ) {
 	return accumulator;
 
 	/**
-	* If provided a value, the accumulator function returns an updated prodct. If not provided a value, the accumulator function returns the current prodct.
+	* If provided a value, the accumulator function returns an updated product. If not provided a value, the accumulator function returns the current product.
 	*
 	* @private
 	* @param {number} [x] - input value
diff --git a/lib/node_modules/@stdlib/stats/pcorrtest/lib/index.js b/lib/node_modules/@stdlib/stats/pcorrtest/lib/index.js
@@ -24,8 +24,8 @@
 * @module @stdlib/stats/pcorrtest
 *
 * @example
-* var pcorrtest = require( '@stdlib/stats/pcorrtest' );
 * var incrspace = require( '@stdlib/array/base/incrspace' );
+* var pcorrtest = require( '@stdlib/stats/pcorrtest' );
 *
 * var a = incrspace( 1, 11, 1 );
 * var b = incrspace( 11, 21, 1 );
diff --git a/lib/node_modules/@stdlib/stats/pcorrtest/lib/validate.js b/lib/node_modules/@stdlib/stats/pcorrtest/lib/validate.js
@@ -43,7 +43,7 @@ var alternative = [ 'two-sided', 'less', 'greater' ];
 * @param {Options} options - function options
 * @param {number} [options.alpha] - significance level
 * @param {string} [options.alternative] - alternative hypothesis (`two-sided`, `less` or `greater`)
-* @param {number} [options.rho] - correlation coefficient unter HO
+* @param {number} [options.rho] - correlation coefficient under HO
 * @returns {(null|Error)} null or an error
 *
 * @example

Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,6 @@`
`31`	`31`	* - Only API which is universal is `setTimeout`.
`32`	`32`	* - Note that `0` is not actually `0ms`. Browser environments commonly have a minimum delay of `4ms`. This is acceptable. Here, the main intent of this function is to give the runtime a chance to run garbage collection, clear state, and tend to any other pending tasks before returning control to benchmark tasks. The larger aim (attainable or not) is to provide each benchmark run with as much of a fresh state as possible.
`33`	`33`	`*`
`34`		`-*`
`35`	`34`	`* @private`
`36`	`35`	`* @param {Function} fcn - function to run upon a subsequent turn of the event loop`
`37`	`36`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -59,23 +59,23 @@ var ca = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];`
`59`	`59`	`* @returns {Collection} output array`
`60`	`60`	`*`
`61`	`61`	`* @example`
`62`		`-* var v = ellipj( 0.3, 0.5, [ 0.0, 0.0, 0.0, 0.0 ], 1, 0 );`
	`62`	`+* var v = assign( 0.3, 0.5, [ 0.0, 0.0, 0.0, 0.0 ], 1, 0 );`
`63`	`63`	`* // returns [ ~0.293, ~0.956, ~0.978, ~0.298 ]`
`64`	`64`	`*`
`65`	`65`	`* @example`
`66`		`-* v = ellipj( 0.0, 0.0, [ 0.0, 0.0, 0.0, 0.0 ], 1, 0 );`
	`66`	`+* v = assign( 0.0, 0.0, [ 0.0, 0.0, 0.0, 0.0 ], 1, 0 );`
`67`	`67`	`* // returns [ ~0.0, ~1.0, ~1.0, ~0.0 ]`
`68`	`68`	`*`
`69`	`69`	`* @example`
`70`		`-* v = ellipj( Infinity, 1.0, [ 0.0, 0.0, 0.0, 0.0 ], 1, 0 );`
	`70`	`+* v = assign( Infinity, 1.0, [ 0.0, 0.0, 0.0, 0.0 ], 1, 0 );`
`71`	`71`	`* // returns [ ~1.0, ~0.0, ~0.0, ~1.571 ]`
`72`	`72`	`*`
`73`	`73`	`* @example`
`74`		`-* v = ellipj( 0.0, -2.0, [ 0.0, 0.0, 0.0, 0.0 ], 1, 0 );`
	`74`	`+* v = assign( 0.0, -2.0, [ 0.0, 0.0, 0.0, 0.0 ], 1, 0 );`
`75`	`75`	`* // returns [ ~0.0, ~1.0, ~1.0, NaN ]`
`76`	`76`	`*`
`77`	`77`	`* @example`
`78`		`-* v = ellipj( NaN, NaN, [ 0.0, 0.0, 0.0, 0.0 ], 1, 0 );`
	`78`	`+* v = assign( NaN, NaN, [ 0.0, 0.0, 0.0, 0.0 ], 1, 0 );`
`79`	`79`	`* // returns [ NaN, NaN, NaN, NaN ]`
`80`	`80`	`*/`
`81`	`81`	`function assign(u, m, out, stride, offset) {`
Original file line number	Diff line number	Diff line change
`@@ -67,6 +67,7 @@ var MAX_FACTORIAL = 170; // TODO: consider packaging as constant`
`67`	`67`	`* \operatorname{risingFactorial}(x, n) = \frac{ \Gamma(x + n) }{ \Gamma(x) };`
`68`	`68`	* ```
`69`	`69`	`*`
	`70`	`+* @private`
`70`	`71`	`* @param {number} x - first function parameter`
`71`	`72`	`* @param {integer} n - second function parameter`
`72`	`73`	`* @returns {number} function value`
Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ var isnan = require( '@stdlib/assert/is-nan' );`
`47`	`47`	`*`
`48`	`48`	`* var options = {`
`49`	`49`	`* 'alpha': 0.05,`
`50`		`-* 'alernative': 'two-sided',`
	`50`	`+* 'alternative': 'two-sided',`
`51`	`51`	`* 'init': 100`
`52`	`52`	`* };`
`53`	`53`	`*`
Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ var isnan = require( '@stdlib/assert/is-nan' );`
`45`	`45`	`*`
`46`	`46`	`* var options = {`
`47`	`47`	`* 'alpha': 0.05,`
`48`		`-* 'alernative': 'two-sided'`
	`48`	`+* 'alternative': 'two-sided'`
`49`	`49`	`* };`
`50`	`50`	`*`
`51`	`51`	`* var err = validate( opts, options );`
Original file line number	Diff line number	Diff line change
`@@ -126,7 +126,7 @@ function incrmprod( W ) {`
`126`	`126`	`return accumulator;`
`127`	`127`
`128`	`128`	`/**`
`129`		`- * If provided a value, the accumulator function returns an updated prodct. If not provided a value, the accumulator function returns the current prodct.`
	`129`	`+ * If provided a value, the accumulator function returns an updated product. If not provided a value, the accumulator function returns the current product.`
`130`	`130`	`*`
`131`	`131`	`* @private`
`132`	`132`	`* @param {number} [x] - input value`
Original file line number	Diff line number	Diff line change
`@@ -24,8 +24,8 @@`
`24`	`24`	`* @module @stdlib/stats/pcorrtest`
`25`	`25`	`*`
`26`	`26`	`* @example`
`27`		`-* var pcorrtest = require( '@stdlib/stats/pcorrtest' );`
`28`	`27`	`* var incrspace = require( '@stdlib/array/base/incrspace' );`
	`28`	`+* var pcorrtest = require( '@stdlib/stats/pcorrtest' );`
`29`	`29`	`*`
`30`	`30`	`* var a = incrspace( 1, 11, 1 );`
`31`	`31`	`* var b = incrspace( 11, 21, 1 );`
Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@ var alternative = [ 'two-sided', 'less', 'greater' ];`
`43`	`43`	`* @param {Options} options - function options`
`44`	`44`	`* @param {number} [options.alpha] - significance level`
`45`	`45`	* @param {string} [options.alternative] - alternative hypothesis (`two-sided`, `less` or `greater`)
`46`		`-* @param {number} [options.rho] - correlation coefficient unter HO`
	`46`	`+* @param {number} [options.rho] - correlation coefficient under HO`
`47`	`47`	`* @returns {(null\|Error)} null or an error`
`48`	`48`	`*`
`49`	`49`	`* @example`