chore: minor clean-up

aman-095 · Oct 3, 2024 · 89e005a · 89e005a
1 parent 99cca3d
commit 89e005a
Show file tree

Hide file tree

Showing 17 changed files with 148 additions and 110 deletions.
diff --git a/lib/node_modules/@stdlib/array/base/cuany-by/README.md b/lib/node_modules/@stdlib/array/base/cuany-by/README.md
@@ -127,6 +127,7 @@ function isPositive( value ) {
 var x = bernoulli( 10, 0.1 );
 console.log( x );
 
+// Cumulatively determine whether at least one element is positive:
 var out = cuanyBy( x, isPositive );
 console.log( out );
 ```

diff --git a/lib/node_modules/@stdlib/array/base/cuany-by/benchmark/benchmark.length.js b/lib/node_modules/@stdlib/array/base/cuany-by/benchmark/benchmark.length.js
@@ -26,7 +26,7 @@ var isArray = require( '@stdlib/assert/is-array' );
 var filled = require( '@stdlib/array/base/filled' );
 var isPositiveInteger = require( '@stdlib/assert/is-positive-integer' ).isPrimitive;
 var pkg = require( '@stdlib/array/base/cuany-by/package.json' ).name;
-var cuanyBy = require( '@stdlib/array/base/cuany-by/lib' );
+var cuanyBy = require( './../lib' );
 
 
 // FUNCTIONS //
@@ -39,7 +39,7 @@ var cuanyBy = require( '@stdlib/array/base/cuany-by/lib' );
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var x = filled( 1.5, len );
+	var x = filled( 0, len );
 	return benchmark;
 
 	/**

diff --git a/lib/node_modules/@stdlib/array/base/cuany-by/docs/repl.txt b/lib/node_modules/@stdlib/array/base/cuany-by/docs/repl.txt
@@ -55,6 +55,9 @@
     predicate: Function
         Predicate function.
 
+    thisArg: any (optional)
+        Execution context.
+
     Returns
     -------
     y: ArrayLikeObject

diff --git a/lib/node_modules/@stdlib/array/base/cuany-by/docs/types/test.ts b/lib/node_modules/@stdlib/array/base/cuany-by/docs/types/test.ts
@@ -56,7 +56,24 @@ function isPositive( value: number ): boolean {
 	cuanyBy( new Uint8ClampedArray( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType boolean[]
 }
 
-// The compiler throws an error if the function is provided a first argument which is not like a function..
+// The compiler throws an error if the function is provided a first argument which is not an array-like object...
+{
+	cuanyBy( 1, isPositive ); // $ExpectError
+	cuanyBy( true, isPositive ); // $ExpectError
+	cuanyBy( false, isPositive ); // $ExpectError
+	cuanyBy( null, isPositive ); // $ExpectError
+	cuanyBy( void 0, isPositive ); // $ExpectError
+	cuanyBy( {}, isPositive ); // $ExpectError
+
+	cuanyBy( 1, isPositive, {} ); // $ExpectError
+	cuanyBy( true, isPositive, {} ); // $ExpectError
+	cuanyBy( false, isPositive, {} ); // $ExpectError
+	cuanyBy( null, isPositive, {} ); // $ExpectError
+	cuanyBy( void 0, isPositive, {} ); // $ExpectError
+	cuanyBy( {}, isPositive, {} ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided a second argument which is not function...
 {
 	const x = [ 1, 2, 3, 4 ];
 
@@ -147,7 +164,6 @@ function isPositive( value: number ): boolean {
 	cuanyBy.assign( x, {}, 2, 0, isPositive, {} ); // $ExpectError
 }
 
-
 // The compiler throws an error if the `assign` method is provided a third argument which is not a number...
 {
 	const x = [ false, false, true, false, false ];
@@ -192,7 +208,7 @@ function isPositive( value: number ): boolean {
 	cuanyBy.assign( x, y, 1, [], isPositive, {} ); // $ExpectError
 }
 
-// The compiler throws an error if the `assign` method is provided a fourth argument which is not like a function...
+// The compiler throws an error if the `assign` method is provided a fifth argument which is not like a function...
 {
 	const x = [ false, false, true, false, false ];
 	const y = [ false, null, false, null, false, null, false, null, false, null ];

diff --git a/lib/node_modules/@stdlib/array/base/cuany-by/examples/index.js b/lib/node_modules/@stdlib/array/base/cuany-by/examples/index.js
@@ -19,13 +19,16 @@
 'use strict';
 
 var bernoulli = require( '@stdlib/random/array/bernoulli' );
-var isPositiveInteger = require( '@stdlib/assert/is-positive-integer' );
 var cuanyBy = require( './../lib' );
 
+function isPositive( value ) {
+	return ( value > 0 );
+}
+
 // Create an array of random values:
 var x = bernoulli( 10, 0.1 );
 console.log( x );
 
-// Cumulatively determine whether values are truthy:
-var out = cuanyBy( x, isPositiveInteger );
+// Cumulatively determine whether at least one element is positive:
+var out = cuanyBy( x, isPositive );
 console.log( out );
diff --git a/lib/node_modules/@stdlib/array/base/cuany-by/lib/assign.js b/lib/node_modules/@stdlib/array/base/cuany-by/lib/assign.js
@@ -78,13 +78,13 @@ function indexed( x, y, stride, offset, predicate, thisArg ) {
 * @returns {Collection} output array
 *
 * @example
+* var toAccessorArray = require( '@stdlib/array/base/to-accessor-array' );
+* var arraylike2object = require( '@stdlib/array/base/arraylike2object' );
+*
 * function isPositive( v ) {
 *     return v > 0;
 * }
 *
-* var toAccessorArray = require( '@stdlib/array/base/to-accessor-array' );
-* var arraylike2object = require( '@stdlib/array/base/arraylike2object' );
-*
 * var x = toAccessorArray( [ false, false, false, true, false ] );
 * var y = toAccessorArray( [ false, null, false, null, false, null, false, null, false, null ] );
 *
@@ -136,7 +136,7 @@ function accessors( x, y, stride, offset, predicate, thisArg ) {
 // MAIN //
 
 /**
-* Cumulatively tests whether at least one element in a provided array passes a test implemented by a predicate function and assigns results to provided output array.
+* Cumulatively tests whether at least one element in a provided array passes a test implemented by a predicate function and assigns results to a provided output array.
 *
 * @param {Collection} x - input array
 * @param {Collection} y - output array