Update docs and change message start to lowercase

Planeshifter · Planeshifter · commit 8bd34f684390 · 2022-04-04T16:14:53.000-04:00
diff --git a/lib/node_modules/@stdlib/stats/kstest/lib/main.js b/lib/node_modules/@stdlib/stats/kstest/lib/main.js
@@ -155,7 +155,7 @@ function kstest() {
 		stat = max( n, x, 1 );
 		break;
 	default:
-		throw new Error( format( 'Invalid option. `alternative` must be either `two-sided`, `less`, or `greater`. Option: `%s`.', alt ) );
+		throw new Error( format( 'invalid option. `alternative` must be either `two-sided`, `less`, or `greater`. Option: `%s`.', alt ) );
 	}
 	if ( alt === 'two-sided' ) {
 		pval = 1.0 - pKolmogorov( stat, n );
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. `variance` must be either `equal` or `unequal`. Value: `%s`.', vars ) );
 	}
 
 	xmean = mean( nx, x, 1 );
@@ -157,7 +157,7 @@ function ttest2( x, y, options ) {
 		cint[ 1 ] = diff + (cint[ 1 ] * stderr);
 		break;
 	default:
-		throw new Error( format( 'Invalid option. `alternative` must be either `two-sided`, `less`, or `greater`. Option: `%s`.', alt ) );
+		throw new Error( format( 'invalid option. `alternative` must be either `two-sided`, `less`, or `greater`. Option: `%s`.', alt ) );
 	}
 	out = {};
 	setReadOnly( out, 'rejected', pval <= alpha );
diff --git a/lib/node_modules/@stdlib/stats/vartest/lib/main.js b/lib/node_modules/@stdlib/stats/vartest/lib/main.js
@@ -133,7 +133,7 @@ function vartest( x, y, options ) {
 		];
 		break;
 	default:
-		throw new Error( format( 'Invalid option. `alternative` must be either `two-sided`, `less`, or `greater`. Option: `%s`.', alt ) );
+		throw new Error( format( 'invalid option. `alternative` must be either `two-sided`, `less`, or `greater`. Option: `%s`.', alt ) );
 	}
 	out = {};
 	setReadOnly( out, 'rejected', pval <= alpha );
diff --git a/lib/node_modules/@stdlib/stats/ztest/lib/main.js b/lib/node_modules/@stdlib/stats/ztest/lib/main.js
@@ -142,7 +142,7 @@ function ztest( x, sigma, options ) {
 		cint[ 1 ] = mu + (cint[ 1 ] * stderr);
 		break;
 	default:
-		throw new Error( format( 'Invalid option. `alternative` must be either `two-sided`, `less`, or `greater`. Option: `%s`.', alt ) );
+		throw new Error( format( 'invalid option. `alternative` must be either `two-sided`, `less`, or `greater`. Option: `%s`.', alt ) );
 	}
 	out = {};
 	setReadOnly( out, 'rejected', pval <= alpha );
diff --git a/lib/node_modules/@stdlib/stats/ztest2/lib/main.js b/lib/node_modules/@stdlib/stats/ztest2/lib/main.js
@@ -140,7 +140,7 @@ function ztest2( x, y, sigmax, sigmay, options ) {
 		cint[ 1 ] = diff + (cint[ 1 ] * stderr);
 		break;
 	default:
-		throw new Error( format( 'Invalid option. `alternative` must be either `two-sided`, `less`, or `greater`. Option: `%s`.', alt ) );
+		throw new Error( format( 'invalid option. `alternative` must be either `two-sided`, `less`, or `greater`. Option: `%s`.', alt ) );
 	}
 	out = {};
 	setReadOnly( out, 'rejected', pval <= alpha );
diff --git a/lib/node_modules/@stdlib/string/format/README.md b/lib/node_modules/@stdlib/string/format/README.md
@@ -48,7 +48,9 @@ var out = format( str, 'world', 'Bob' );
 
 The format string is a string literal containing zero or more conversion specifications, each of which results in a string value being inserted to the output string. A conversion specification consists of a percent sign (`%`) followed by one or more of the following flags, width, precision, and conversion type characters. It thus takes the following form:
 
-    %[flags][width][.precision]specifier
+```text
+%[flags][width][.precision]specifier
+```
 
 Arguments following the format string are used to replace the placeholders in the format string. The number of arguments following the format string should be equal to the number of placeholders in the format string.
 
@@ -60,7 +62,9 @@ var out = format( str, 'Hello', 'World' );
 
 To supply arguments in a different order than they appear in the format string, positional placeholders as indicated by a `$` character in the format string are used. In this case, the conversion specification takes the form:
 
-    %[pos$][flags][width][.precision]specifier
+```text
+%[pos$][flags][width][.precision]specifier
+```
 
 ```javascript
 var str = '%3$s %2$s %1$s';
@@ -176,7 +180,7 @@ out = format( str, 5, 2 );
 The `precision` may be specified as a decimal integer or as an asterisk character (`*`), in which case the argument preceding the conversion specification is used as the precision value. The behavior of the `precision` differs depending on the conversion type:
 
 -   For `s` specifiers, the `precision` specifies the maximum number of characters to be written to the output.
--   For floating point specifiers (`f`, `F`, `e`, `E`), the `precision` specifies the number of digits after the decimal point to be written to the output (by default, this is `6).
+-   For floating point specifiers (`f`, `F`, `e`, `E`), the `precision` specifies the number of digits after the decimal point to be written to the output (by default, this is `6`).
 -  For `g` and `G` specifiers, the `precision` specifies the maximum number of significant digits to be written to the output.
 -  For integer specifiers (`d`, `i`, `u`, `b`, `o`, `x`, `X`), the `precision` specifies the minimum number of digits to be written to the output. If the value to be written is shorter than this number, the result is padded with zeros on the left. The value is not truncated even if the result is longer. For 
 

Original file line number	Diff line number	Diff line change
`@@ -155,7 +155,7 @@ function kstest() {`
`155`	`155`	`stat = max( n, x, 1 );`
`156`	`156`	`break;`
`157`	`157`	`default:`
`158`		- throw new Error( format( 'Invalid option. `alternative` must be either `two-sided`, `less`, or `greater`. Option: `%s`.', alt ) );
	`158`	+ throw new Error( format( 'invalid option. `alternative` must be either `two-sided`, `less`, or `greater`. Option: `%s`.', alt ) );
`159`	`159`	`}`
`160`	`160`	`if ( alt === 'two-sided' ) {`
`161`	`161`	`pval = 1.0 - pKolmogorov( stat, n );`
Original file line number	Diff line number	Diff line change
`@@ -128,7 +128,7 @@ function ttest2( x, y, options ) {`
`128`	`128`	`df = pow( stderr, 4 ) / v;`
`129`	`129`	`}`
`130`	`130`	`else {`
`131`		- throw new Error( format( 'Invalid option. `variance` must be either `equal` or `unequal`. Value: `%s`.', vars ) );
	`131`	+ throw new Error( format( 'invalid option. `variance` must be either `equal` or `unequal`. Value: `%s`.', vars ) );
`132`	`132`	`}`
`133`	`133`
`134`	`134`	`xmean = mean( nx, x, 1 );`
`@@ -157,7 +157,7 @@ function ttest2( x, y, options ) {`
`157`	`157`	`cint[ 1 ] = diff + (cint[ 1 ] * stderr);`
`158`	`158`	`break;`
`159`	`159`	`default:`
`160`		- throw new Error( format( 'Invalid option. `alternative` must be either `two-sided`, `less`, or `greater`. Option: `%s`.', alt ) );
	`160`	+ throw new Error( format( 'invalid option. `alternative` must be either `two-sided`, `less`, or `greater`. Option: `%s`.', alt ) );
`161`	`161`	`}`
`162`	`162`	`out = {};`
`163`	`163`	`setReadOnly( out, 'rejected', pval <= alpha );`
Original file line number	Diff line number	Diff line change
`@@ -133,7 +133,7 @@ function vartest( x, y, options ) {`
`133`	`133`	`];`
`134`	`134`	`break;`
`135`	`135`	`default:`
`136`		- throw new Error( format( 'Invalid option. `alternative` must be either `two-sided`, `less`, or `greater`. Option: `%s`.', alt ) );
	`136`	+ throw new Error( format( 'invalid option. `alternative` must be either `two-sided`, `less`, or `greater`. Option: `%s`.', alt ) );
`137`	`137`	`}`
`138`	`138`	`out = {};`
`139`	`139`	`setReadOnly( out, 'rejected', pval <= alpha );`
Original file line number	Diff line number	Diff line change
`@@ -142,7 +142,7 @@ function ztest( x, sigma, options ) {`
`142`	`142`	`cint[ 1 ] = mu + (cint[ 1 ] * stderr);`
`143`	`143`	`break;`
`144`	`144`	`default:`
`145`		- throw new Error( format( 'Invalid option. `alternative` must be either `two-sided`, `less`, or `greater`. Option: `%s`.', alt ) );
	`145`	+ throw new Error( format( 'invalid option. `alternative` must be either `two-sided`, `less`, or `greater`. Option: `%s`.', alt ) );
`146`	`146`	`}`
`147`	`147`	`out = {};`
`148`	`148`	`setReadOnly( out, 'rejected', pval <= alpha );`
Original file line number	Diff line number	Diff line change
`@@ -140,7 +140,7 @@ function ztest2( x, y, sigmax, sigmay, options ) {`
`140`	`140`	`cint[ 1 ] = diff + (cint[ 1 ] * stderr);`
`141`	`141`	`break;`
`142`	`142`	`default:`
`143`		- throw new Error( format( 'Invalid option. `alternative` must be either `two-sided`, `less`, or `greater`. Option: `%s`.', alt ) );
	`143`	+ throw new Error( format( 'invalid option. `alternative` must be either `two-sided`, `less`, or `greater`. Option: `%s`.', alt ) );
`144`	`144`	`}`
`145`	`145`	`out = {};`
`146`	`146`	`setReadOnly( out, 'rejected', pval <= alpha );`