Update error messages

Planeshifter · Planeshifter · commit 2601b4ccc04b · 2022-04-25T22:27:01.000-04:00
diff --git a/lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-doctest-quote-props/test/fixtures/valid.js b/lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-doctest-quote-props/test/fixtures/valid.js
@@ -147,7 +147,7 @@ test = {
 		'		throw new TypeError( \'invalid argument. Must provide an array of nonnegative integers. Value: `\' + time + \'`.\' );',
 		'	}',
 		'	if ( time.length !== 2 ) {',
-		'		throw new RangeError( \'invalid argument. Input array must have length `2`.\' );',
+		'		throw new RangeError( \'invalid argument. Input array must contain two elements.\' );',
 		'	}',
 		'	sec = now[ 0 ] - time[ 0 ];',
 		'	ns = now[ 1 ] - time[ 1 ];',
diff --git a/lib/node_modules/@stdlib/_tools/github/create-issue/lib/validate.js b/lib/node_modules/@stdlib/_tools/github/create-issue/lib/validate.js
@@ -26,9 +26,15 @@ var isString = require( '@stdlib/assert/is-string' ).isPrimitive;
 var isStringArray = require( '@stdlib/assert/is-string-array' ).primitives;
 var isNonNegativeInteger = require( '@stdlib/assert/is-nonnegative-integer' ).isPrimitive;
 var isPositiveInteger = require( '@stdlib/assert/is-positive-integer' ).isPrimitive;
+var indexOf = require( '@stdlib/utils/index-of' );
 var format = require( '@stdlib/string/format' );
 
 
+// VARIABLES //
+
+var PROTOCOLS = [ 'http', 'https' ];
+
+
 // MAIN //
 
 /**
@@ -61,8 +67,8 @@ function validate( opts, options ) {
 		if ( !isString( opts.protocol ) ) {
 			return new TypeError( format( 'invalid option. `%s` option must be a string. Option: `%s`.', 'protocol', opts.protocol ) );
 		}
-		if ( opts.protocol !== 'http' && opts.protocol !== 'https' ) {
-			return new Error( format( 'invalid option. `protocol` must be either `http` or `https`. Option: `%s`.', opts.protocol ) );
+		if ( indexOf( PROTOCOLS, opts.protocol ) === -1 ) {
+			return new Error( format( 'invalid option. `%s` must be one of the following: "%s". Option: `%s`.', 'protocol', PROTOCOLS.join( '", "' ), opts.protocol ) );
 		}
 	}
 	if ( hasOwnProp( options, 'hostname' ) ) {
diff --git a/lib/node_modules/@stdlib/math/tools/unary/lib/validate.js b/lib/node_modules/@stdlib/math/tools/unary/lib/validate.js
@@ -58,7 +58,7 @@ var DTYPES = dtypes();
 */
 function validate( opts, options ) {
 	if ( !isPlainObject( options ) ) {
-		return new TypeError( format( 'invalid argument. Options argument must be a plain object. Value: `%s`.', options ) );
+		return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );
 	}
 	if ( hasOwnProp( options, 'dtype' ) ) {
 		opts.dtype = options.dtype;
diff --git a/lib/node_modules/@stdlib/math/tools/unary/lib/validate_options.js b/lib/node_modules/@stdlib/math/tools/unary/lib/validate_options.js
@@ -50,7 +50,7 @@ var POLICIES = require( './policies.json' );
 */
 function validate( opts, options ) {
 	if ( !isPlainObject( options ) ) {
-		return new TypeError( format( 'invalid argument. Options argument must be a plain object. Value: `%s`.', options ) );
+		return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );
 	}
 	if ( hasOwnProp( options, 'output_dtype_policy' ) ) {
 		opts.policy = options.output_dtype_policy;
diff --git a/lib/node_modules/@stdlib/math/tools/unary/lib/validate_table.js b/lib/node_modules/@stdlib/math/tools/unary/lib/validate_table.js
@@ -62,7 +62,7 @@ function validate( out, table ) {
 	var i;
 
 	if ( !isPlainObject( table ) ) {
-		return new TypeError( format( 'invalid argument. Resolution table must be a plain object. Value: `%s`.', table ) );
+		return new TypeError( format( 'invalid argument. Resolution table must be an object. Value: `%s`.', table ) );
 	}
 	fields = objectKeys( out );
 	for ( i = 0; i < fields.length; i++ ) {
diff --git a/lib/node_modules/@stdlib/plot/base/ctor/lib/props/engine/set.js b/lib/node_modules/@stdlib/plot/base/ctor/lib/props/engine/set.js
@@ -43,7 +43,7 @@ var debug = logger( 'plot:base:set:engine' );
 function set( engine ) {
 	/* eslint-disable no-invalid-this */
 	if ( !contains( ENGINES, engine ) ) {
-		throw new TypeError( format( 'invalid value. `%s` must be one of "%s". Value: `%s`.', 'engine', ENGINES.join( '", "' ), engine ) );
+		throw new TypeError( format( 'invalid value. `%s` must be one of the following: "%s". Value: `%s`.', 'engine', ENGINES.join( '", "' ), engine ) );
 	}
 	if ( engine !== this._engine ) {
 		debug( 'Current value: %s.', this._engine );
diff --git a/lib/node_modules/@stdlib/plot/base/ctor/lib/props/x-axis-orient/set.js b/lib/node_modules/@stdlib/plot/base/ctor/lib/props/x-axis-orient/set.js
@@ -43,7 +43,7 @@ var debug = logger( 'plot:base:set:x-axis-orient' );
 function set( orientation ) {
 	/* eslint-disable no-invalid-this */
 	if ( indexOf( ORIENTATIONS, orientation ) === -1 ) {
-		throw new TypeError( format( 'invalid value. `%s` must be one of "%s". Value: `%s`.', 'xAxisOrient', ORIENTATIONS.join( '", "' ), orientation ) );
+		throw new TypeError( format( 'invalid value. `%s` must be one of the following: "%s". Value: `%s`.', 'xAxisOrient', ORIENTATIONS.join( '", "' ), orientation ) );
 	}
 	if ( orientation !== this._xAxisOrient ) {
 		debug( 'Current value: %s.', this._xAxisOrient );
diff --git a/lib/node_modules/@stdlib/plot/base/ctor/lib/props/y-axis-orient/set.js b/lib/node_modules/@stdlib/plot/base/ctor/lib/props/y-axis-orient/set.js
@@ -43,7 +43,7 @@ var debug = logger( 'plot:base:set:y-axis-orient' );
 function set( orientation ) {
 	/* eslint-disable no-invalid-this */
 	if ( indexOf( ORIENTATIONS, orientation ) === -1 ) {
-		throw new TypeError( format( 'invalid value. `%s` must be one of "%s". Value: `%s`.', 'yAxisOrient', ORIENTATIONS.join( '", "' ), orientation ) );
+		throw new TypeError( format( 'invalid value. `%s` must be one of the following: "%s". Value: `%s`.', 'yAxisOrient', ORIENTATIONS.join( '", "' ), orientation ) );
 	}
 	if ( orientation !== this._yAxisOrient ) {
 		debug( 'Current value: %s.', this._yAxisOrient );
diff --git a/lib/node_modules/@stdlib/plot/components/svg/axis/lib/validators/orientation.js b/lib/node_modules/@stdlib/plot/components/svg/axis/lib/validators/orientation.js
@@ -36,7 +36,7 @@ var ORIENTATIONS = require( './../etc/orientations.json' );
 */
 function test( v ) {
 	if ( indexOf( ORIENTATIONS, v ) === -1 ) {
-		return new TypeError( format( 'invalid value. `%s` must be one of "%s". Value: `%s`.', 'orientation', ORIENTATIONS.join( '", "' ), v ) );
+		return new TypeError( format( 'invalid value. `%s` must be one of the following: "%s". Value: `%s`.', 'orientation', ORIENTATIONS.join( '", "' ), v ) );
 	}
 	return null;
 }
diff --git a/lib/node_modules/@stdlib/plot/components/svg/rug/lib/props/orientation/set.js b/lib/node_modules/@stdlib/plot/components/svg/rug/lib/props/orientation/set.js
@@ -43,7 +43,7 @@ var debug = logger( 'rug:set:orientation' );
 function set( orient ) {
 	/* eslint-disable no-invalid-this */
 	if ( indexOf( ORIENTATIONS, orient ) === -1 ) {
-		throw new Error( format( 'invalid value. `%s` must be one of "%s". Value: `%s`.', 'orientation', ORIENTATIONS.join( '", "' ), orient ) );
+		throw new Error( format( 'invalid value. `%s` must be one of the following: "%s". Value: `%s`.', 'orientation', ORIENTATIONS.join( '", "' ), orient ) );
 	}
 	if ( orient !== this._orientation ) {
 		debug( 'Current value: %d.', this._orientation );
diff --git a/lib/node_modules/@stdlib/plot/ctor/lib/props/engine/set.js b/lib/node_modules/@stdlib/plot/ctor/lib/props/engine/set.js
@@ -43,7 +43,7 @@ var debug = logger( 'plot:set:engine' );
 function set( engine ) {
 	/* eslint-disable no-invalid-this */
 	if ( !contains( ENGINES, engine ) ) {
-		throw new TypeError( format( 'invalid value. `%s` must be one of "%s". Value: `%s`.', 'engine', ENGINES.join( '", "' ), engine ) );
+		throw new TypeError( format( 'invalid value. `%s` must be one of the following: "%s". Value: `%s`.', 'engine', ENGINES.join( '", "' ), engine ) );
 	}
 	if ( engine !== this._engine ) {
 		debug( 'Current value: %s.', this._engine );
diff --git a/lib/node_modules/@stdlib/plot/ctor/lib/props/x-axis-orient/set.js b/lib/node_modules/@stdlib/plot/ctor/lib/props/x-axis-orient/set.js
@@ -43,7 +43,7 @@ var debug = logger( 'plot:set:x-axis-orient' );
 function set( orientation ) {
 	/* eslint-disable no-invalid-this */
 	if ( indexOf( ORIENTATIONS, orientation ) === -1 ) {
-		throw new TypeError( format( 'invalid value. `%s` must be one of "%s". Value: `%s`.', 'xAxisOrient', ORIENTATIONS.join( '", "' ), orientation ) );
+		throw new TypeError( format( 'invalid value. `%s` must be one of the following: "%s". Value: `%s`.', 'xAxisOrient', ORIENTATIONS.join( '", "' ), orientation ) );
 	}
 	if ( orientation !== this._xAxisOrient ) {
 		debug( 'Current value: %s.', this._xAxisOrient );
diff --git a/lib/node_modules/@stdlib/plot/ctor/lib/props/y-axis-orient/set.js b/lib/node_modules/@stdlib/plot/ctor/lib/props/y-axis-orient/set.js
@@ -43,7 +43,7 @@ var debug = logger( 'plot:set:y-axis-orient' );
 function set( orientation ) {
 	/* eslint-disable no-invalid-this */
 	if ( indexOf( ORIENTATIONS, orientation ) === -1 ) {
-		throw new TypeError( format( 'invalid value. `%s` must be one of "%s". Value: `%s`.', 'yAxisOrient', ORIENTATIONS.join( '", "' ), orientation ) );
+		throw new TypeError( format( 'invalid value. `%s` must be one of the following: "%s". Value: `%s`.', 'yAxisOrient', ORIENTATIONS.join( '", "' ), orientation ) );
 	}
 	if ( orientation !== this._yAxisOrient ) {
 		debug( 'Current value: %s.', this._yAxisOrient );
diff --git a/lib/node_modules/@stdlib/plot/sparklines/unicode/lib/props/type/set.js b/lib/node_modules/@stdlib/plot/sparklines/unicode/lib/props/type/set.js
@@ -43,7 +43,7 @@ var debug = logger( 'sparkline:unicode:set:type' );
 function set( type ) {
 	/* eslint-disable no-invalid-this */
 	if ( !contains( CHART_TYPES, type ) ) {
-		throw new TypeError( format( 'invalid value. `%s` must be one of "%s". Value: `%s`.', 'type', CHART_TYPES.join( '", "' ), type ) );
+		throw new TypeError( format( 'invalid value. `%s` must be one of the following: "%s". Value: `%s`.', 'type', CHART_TYPES.join( '", "' ), type ) );
 	}
 	if ( type !== this._type ) {
 		debug( 'Current value: %s.', this._type );
diff --git a/lib/node_modules/@stdlib/regexp/basename/lib/main.js b/lib/node_modules/@stdlib/regexp/basename/lib/main.js
@@ -49,7 +49,7 @@ var PLATFORMS = [ 'posix', 'win32' ];
 function reBasename( platform ) {
 	if ( arguments.length > 0 ) {
 		if ( !contains( PLATFORMS, platform ) ) {
-			throw new Error( format( 'invalid argument. Platform must be either `posix` or `win32`. Value: `%s`.', platform ) );
+			throw new Error( format( 'invalid argument. Must be one of the following: "%s". Value: `%s`.', PLATFORMS.join( '", "' ), platform ) );
 		}
 	}
 	if ( platform === 'win32' || IS_WINDOWS ) {
diff --git a/lib/node_modules/@stdlib/regexp/dirname/lib/main.js b/lib/node_modules/@stdlib/regexp/dirname/lib/main.js
@@ -49,7 +49,7 @@ var PLATFORMS = [ 'posix', 'win32' ];
 function reDirname( platform ) {
 	if ( arguments.length > 0 ) {
 		if ( !contains( PLATFORMS, platform ) ) {
-			throw new Error( format( 'invalid argument. Platform must be either `posix` or `win32`. Value: `%s`.', platform ) );
+			throw new Error( format( 'invalid argument.  Must be one of the following: "%s". Value: `%s`.', PLATFORMS.join( '", "' ), platform ) );
 		}
 	}
 	if ( platform === 'win32' || IS_WINDOWS ) {
diff --git a/lib/node_modules/@stdlib/regexp/extname/lib/main.js b/lib/node_modules/@stdlib/regexp/extname/lib/main.js
@@ -49,7 +49,7 @@ var PLATFORMS = [ 'posix', 'win32' ];
 function reExtname( platform ) {
 	if ( arguments.length > 0 ) {
 		if ( !contains( PLATFORMS, platform ) ) {
-			throw new Error( format( 'invalid argument. Platform must be either `posix` or `win32`. Value: `%s`.', platform ) );
+			throw new Error( format( 'invalid argument. Must be one of the following: "%s". Value: `%s`.', PLATFORMS.join( '", "' ), platform ) );
 		}
 	}
 	if ( platform === 'win32' || IS_WINDOWS ) {
diff --git a/lib/node_modules/@stdlib/regexp/filename/lib/main.js b/lib/node_modules/@stdlib/regexp/filename/lib/main.js
@@ -49,7 +49,7 @@ var PLATFORMS = [ 'posix', 'win32' ];
 function reFilename( platform ) {
 	if ( arguments.length > 0 ) {
 		if ( !contains( PLATFORMS, platform ) ) {
-			throw new Error( format( 'invalid argument. Platform must be either `posix` or `win32`. Value: `%s`.', platform ) );
+			throw new Error( format( 'invalid argument. Must be one of the following: "%s". Value: `%s`.', PLATFORMS.join( '", "' ), platform ) );
 		}
 	}
 	if ( platform === 'win32' || IS_WINDOWS ) {
diff --git a/lib/node_modules/@stdlib/stats/binomial-test/lib/main.js b/lib/node_modules/@stdlib/stats/binomial-test/lib/main.js
@@ -106,7 +106,7 @@ function binomialTest() {
 	if ( isNumberArray( arguments[ 0 ] ) ) {
 		x = arguments[ 0 ];
 		if ( x.length !== 2 ) {
-			throw new Error( format( 'invalid argument. If provided an array, it must have two elements. Value: `%s`.', x ) );
+			throw new Error( format( 'invalid argument. An array argument must contain two elements. Value: `%s`.', x ) );
 		}
 		n = x[ 1 ] + x[ 0 ];
 		x = x[ 0 ];
diff --git a/lib/node_modules/@stdlib/stats/incr/covmat/lib/main.js b/lib/node_modules/@stdlib/stats/incr/covmat/lib/main.js
@@ -225,7 +225,7 @@ function incrcovmat( out, means ) {
 			throw new TypeError( format( 'invalid argument. Second argument must be a 1-dimensional ndarray. Value: `%s`.', means ) );
 		}
 		if ( numel( means.shape ) !== order ) {
-			throw new Error( format( 'invalid argument. The number of elements (means) in the second argument must match covariance matrix dimensions. Expected: %u. Actual: %u.', order, numel( means.shape ) ) );
+			throw new Error( format( 'invalid argument. The number of elements (means) in the second argument must match covariance matrix dimensions. Expected: `%u`. Actual: `%u`.', order, numel( means.shape ) ) );
 		}
 		mu = means; // TODO: should we copy this? Otherwise, internal state could be "corrupted" due to mutation outside the accumulator
 		return accumulator2;
diff --git a/lib/node_modules/@stdlib/stats/incr/pcorrdistmat/lib/main.js b/lib/node_modules/@stdlib/stats/incr/pcorrdistmat/lib/main.js
@@ -284,7 +284,7 @@ function incrpcorrdistmat( out, means ) {
 			throw new TypeError( format( 'invalid argument. Second argument must be a 1-dimensional ndarray. Value: `%s`.', means ) );
 		}
 		if ( numel( means.shape ) !== order ) {
-			throw new Error( format( 'invalid argument. The number of elements (means) in the second argument must match correlation distance matrix dimensions. Expected: %u. Actual: %u.', order, numel( means.shape ) ) );
+			throw new Error( format( 'invalid argument. The number of elements (means) in the second argument must match correlation distance matrix dimensions. Expected: `%u`. Actual: `%u`.', order, numel( means.shape ) ) );
 		}
 		mu = means; // TODO: should we copy this? Otherwise, internal state could be "corrupted" due to mutation outside the accumulator
 		return accumulator2;
diff --git a/lib/node_modules/@stdlib/stats/ttest2/lib/main.js b/lib/node_modules/@stdlib/stats/ttest2/lib/main.js
@@ -128,7 +128,7 @@ function ttest2( x, y, options ) {
 		df = pow( stderr, 4 ) / v;
 	}
 	else {
-		throw new Error( format( 'invalid option. `variance` must be either `equal` or `unequal`. Value: `%s`.', vars ) );
+		throw new Error( format( 'invalid option. `%s` option must be either `equal` or `unequal`. Option: `%s`.', 'variance', vars ) );
 	}
 
 	xmean = mean( nx, x, 1 );
diff --git a/lib/node_modules/@stdlib/time/toc/lib/toc.js b/lib/node_modules/@stdlib/time/toc/lib/toc.js
@@ -55,7 +55,7 @@ function toc( time ) {
 		throw new TypeError( format( 'invalid argument. Must provide an array of nonnegative integers. Value: `%s`.', time ) );
 	}
 	if ( time.length !== 2 ) {
-		throw new RangeError( 'invalid argument. Input array must have length `2`.' );
+		throw new RangeError( format( 'invalid argument. Input array must contain two elements. Value: `%s`.', time ) );
 	}
 	sec = now[ 0 ] - time[ 0 ];
 	ns = now[ 1 ] - time[ 1 ];
diff --git a/lib/node_modules/@stdlib/utils/copy/lib/copy.js b/lib/node_modules/@stdlib/utils/copy/lib/copy.js
@@ -34,7 +34,7 @@ var deepCopy = require( './deep_copy.js' );
 *
 * @param {*} value - value to copy
 * @param {NonNegativeInteger} [level=+infinity] - copy depth
-* @throws {TypeError} `level` must be a nonnegative integer
+* @throws {TypeError} second argument must be a nonnegative integer
 * @returns {*} value copy
 *
 * @example
@@ -59,7 +59,7 @@ function copy( value, level ) {
 	var out;
 	if ( arguments.length > 1 ) {
 		if ( !isNonNegativeInteger( level ) ) {
-			throw new TypeError( format( 'invalid argument. `level` must be a nonnegative integer. Value: `%s`.', level ) );
+			throw new TypeError( format( 'invalid argument. Second argument must be a nonnegative integer. Value: `%s`.', level ) );
 		}
 		if ( level === 0 ) {
 			return value;

Original file line number	Diff line number	Diff line change
`@@ -58,7 +58,7 @@ var DTYPES = dtypes();`
`58`	`58`	`*/`
`59`	`59`	`function validate( opts, options ) {`
`60`	`60`	`if ( !isPlainObject( options ) ) {`
`61`		- return new TypeError( format( 'invalid argument. Options argument must be a plain object. Value: `%s`.', options ) );
	`61`	+ return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );
`62`	`62`	`}`
`63`	`63`	`if ( hasOwnProp( options, 'dtype' ) ) {`
`64`	`64`	`opts.dtype = options.dtype;`
Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,7 @@ var POLICIES = require( './policies.json' );`
`50`	`50`	`*/`
`51`	`51`	`function validate( opts, options ) {`
`52`	`52`	`if ( !isPlainObject( options ) ) {`
`53`		- return new TypeError( format( 'invalid argument. Options argument must be a plain object. Value: `%s`.', options ) );
	`53`	+ return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );
`54`	`54`	`}`
`55`	`55`	`if ( hasOwnProp( options, 'output_dtype_policy' ) ) {`
`56`	`56`	`opts.policy = options.output_dtype_policy;`
Original file line number	Diff line number	Diff line change
`@@ -62,7 +62,7 @@ function validate( out, table ) {`
`62`	`62`	`var i;`
`63`	`63`
`64`	`64`	`if ( !isPlainObject( table ) ) {`
`65`		- return new TypeError( format( 'invalid argument. Resolution table must be a plain object. Value: `%s`.', table ) );
	`65`	+ return new TypeError( format( 'invalid argument. Resolution table must be an object. Value: `%s`.', table ) );
`66`	`66`	`}`
`67`	`67`	`fields = objectKeys( out );`
`68`	`68`	`for ( i = 0; i < fields.length; i++ ) {`
Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@ var debug = logger( 'plot:base:set:engine' );`
`43`	`43`	`function set( engine ) {`
`44`	`44`	`/* eslint-disable no-invalid-this */`
`45`	`45`	`if ( !contains( ENGINES, engine ) ) {`
`46`		- throw new TypeError( format( 'invalid value. `%s` must be one of "%s". Value: `%s`.', 'engine', ENGINES.join( '", "' ), engine ) );
	`46`	+ throw new TypeError( format( 'invalid value. `%s` must be one of the following: "%s". Value: `%s`.', 'engine', ENGINES.join( '", "' ), engine ) );
`47`	`47`	`}`
`48`	`48`	`if ( engine !== this._engine ) {`
`49`	`49`	`debug( 'Current value: %s.', this._engine );`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ var ORIENTATIONS = require( './../etc/orientations.json' );`
`36`	`36`	`*/`
`37`	`37`	`function test( v ) {`
`38`	`38`	`if ( indexOf( ORIENTATIONS, v ) === -1 ) {`
`39`		- return new TypeError( format( 'invalid value. `%s` must be one of "%s". Value: `%s`.', 'orientation', ORIENTATIONS.join( '", "' ), v ) );
	`39`	+ return new TypeError( format( 'invalid value. `%s` must be one of the following: "%s". Value: `%s`.', 'orientation', ORIENTATIONS.join( '", "' ), v ) );
`40`	`40`	`}`
`41`	`41`	`return null;`
`42`	`42`	`}`