test: fix description and docs

kgryte · kgryte · commit 96f430f4a1c3 · 2024-06-20T00:24:49.000-07:00
diff --git a/lib/node_modules/@stdlib/array/base/mskput/README.md b/lib/node_modules/@stdlib/array/base/mskput/README.md
@@ -49,7 +49,7 @@ The function supports the following parameters:
 -   **x**: input array.
 -   **mask**: mask array.
 -   **values**: values to set.
--   **mode**: string specifying whether to raise an exception when the number of `values` does not equal the number of falsy `mask` values.
+-   **mode**: string specifying behavior when the number of `values` does not equal the number of falsy `mask` values.
 
 The function supports the following modes:
 
diff --git a/lib/node_modules/@stdlib/array/base/mskput/docs/types/index.d.ts b/lib/node_modules/@stdlib/array/base/mskput/docs/types/index.d.ts
@@ -213,7 +213,7 @@ declare function mskput<T = unknown, U = unknown>( x: AccessorArrayLike<T>, mask
 * @example
 * var x = [ 1, 2, 3, 4 ];
 *
-* var out = mskput( x, [ 1, 0, 0, 1 ], [ 30 ], 'strict' );
+* var out = mskput( x, [ 1, 0, 0, 1 ], [ 30 ], 'strict_broadcast' );
 * // returns [ 1, 30, 30, 4 ]
 *
 * var bool = ( out === x );
diff --git a/lib/node_modules/@stdlib/array/base/mskput/test/test.js b/lib/node_modules/@stdlib/array/base/mskput/test/test.js
@@ -390,7 +390,7 @@ tape( 'when the "mode" is "non_strict", the function throws an error if provided
 	}
 });
 
-tape( 'when the "mode" is "strict_broadcast", the function throws an error if a provided values array which is broadcast incompatible with the number of falsy values in a mask array (insufficient)', function test( t ) {
+tape( 'when the "mode" is "strict_broadcast", the function throws an error if provided a values array which is broadcast incompatible with the number of falsy values in a mask array (insufficient)', function test( t ) {
 	var mask;
 	var x;
 
@@ -405,7 +405,7 @@ tape( 'when the "mode" is "strict_broadcast", the function throws an error if a
 	}
 });
 
-tape( 'when the "mode" is "strict_broadcast", the function throws an error if a provided values array which is broadcast incompatible with the number of falsy values in a mask array (too many)', function test( t ) {
+tape( 'when the "mode" is "strict_broadcast", the function throws an error if provided a values array which is broadcast incompatible with the number of falsy values in a mask array (too many)', function test( t ) {
 	var mask;
 	var x;
 
@@ -420,7 +420,7 @@ tape( 'when the "mode" is "strict_broadcast", the function throws an error if a
 	}
 });
 
-tape( 'when the "mode" is "broadcast", the function throws an error if a provided values array which is broadcast incompatible with the number of falsy values in a mask array', function test( t ) {
+tape( 'when the "mode" is "broadcast", the function throws an error if provided a values array which is broadcast incompatible with the number of falsy values in a mask array', function test( t ) {
 	var mask;
 	var x;
 

Original file line number	Diff line number	Diff line change
`@@ -213,7 +213,7 @@ declare function mskput<T = unknown, U = unknown>( x: AccessorArrayLike<T>, mask`
`213`	`213`	`* @example`
`214`	`214`	`* var x = [ 1, 2, 3, 4 ];`
`215`	`215`	`*`
`216`		`-* var out = mskput( x, [ 1, 0, 0, 1 ], [ 30 ], 'strict' );`
	`216`	`+* var out = mskput( x, [ 1, 0, 0, 1 ], [ 30 ], 'strict_broadcast' );`
`217`	`217`	`* // returns [ 1, 30, 30, 4 ]`
`218`	`218`	`*`
`219`	`219`	`* var bool = ( out === x );`
Original file line number	Diff line number	Diff line change
`@@ -390,7 +390,7 @@ tape( 'when the "mode" is "non_strict", the function throws an error if provided`
`390`	`390`	`}`
`391`	`391`	`});`
`392`	`392`
`393`		`-tape( 'when the "mode" is "strict_broadcast", the function throws an error if a provided values array which is broadcast incompatible with the number of falsy values in a mask array (insufficient)', function test( t ) {`
	`393`	`+tape( 'when the "mode" is "strict_broadcast", the function throws an error if provided a values array which is broadcast incompatible with the number of falsy values in a mask array (insufficient)', function test( t ) {`
`394`	`394`	`var mask;`
`395`	`395`	`var x;`
`396`	`396`
`@@ -405,7 +405,7 @@ tape( 'when the "mode" is "strict_broadcast", the function throws an error if a`
`405`	`405`	`}`
`406`	`406`	`});`
`407`	`407`
`408`		`-tape( 'when the "mode" is "strict_broadcast", the function throws an error if a provided values array which is broadcast incompatible with the number of falsy values in a mask array (too many)', function test( t ) {`
	`408`	`+tape( 'when the "mode" is "strict_broadcast", the function throws an error if provided a values array which is broadcast incompatible with the number of falsy values in a mask array (too many)', function test( t ) {`
`409`	`409`	`var mask;`
`410`	`410`	`var x;`
`411`	`411`
`@@ -420,7 +420,7 @@ tape( 'when the "mode" is "strict_broadcast", the function throws an error if a`
`420`	`420`	`}`
`421`	`421`	`});`
`422`	`422`
`423`		`-tape( 'when the "mode" is "broadcast", the function throws an error if a provided values array which is broadcast incompatible with the number of falsy values in a mask array', function test( t ) {`
	`423`	`+tape( 'when the "mode" is "broadcast", the function throws an error if provided a values array which is broadcast incompatible with the number of falsy values in a mask array', function test( t ) {`
`424`	`424`	`var mask;`
`425`	`425`	`var x;`
`426`	`426`