docs: apply code review suggestions

--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: passed - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
stdlib-js · headlessNode · Jun 20, 2025 · Jun 20, 2025 · Jun 20, 2025 · Jun 21, 2025
commit c62bd4d2239fc035cad5d225e525dbad813659d0
diff --git a/lib/node_modules/@stdlib/ndarray/base/find/README.md b/lib/node_modules/@stdlib/ndarray/base/find/README.md
@@ -20,7 +20,7 @@ limitations under the License.
 
 # find
 
-> Return the first element in an ndarray which pass a test implemented by a predicate function.
+> Return the first element in an ndarray which passes a test implemented by a predicate function.
 
 <section class="intro">
 
@@ -42,14 +42,14 @@ var find = require( '@stdlib/ndarray/base/find' );
 
 #### find( arrays, predicate\[, thisArg] )
 
-Returns the first element in an ndarray which pass a test implemented by a predicate function.
+Returns the first element in an ndarray which passes a test implemented by a predicate function.
 
 <!-- eslint-disable max-len -->
 
 ```javascript
 var Float64Array = require( '@stdlib/array/float64' );
 
-function clbk( value ) {
+function isEven( value ) {
     return value % 2.0 === 0.0;
 }
 
@@ -65,16 +65,6 @@ var sx = [ 4, 4, 1 ];
 // Define the index offset:
 var ox = 0;
 
-// Create the sentinel value ndarray-like object:
-var sentinelValue = {
-    'dtype': 'float64',
-    'data': new Float64Array( [ NaN ] ),
-    'shape': [],
-    'strides': [ 0 ],
-    'offset': 0,
-    'order': 'row-major'
-};
-
 // Create the input ndarray-like object:
 var x = {
     'dtype': 'float64',
@@ -85,14 +75,24 @@ var x = {
     'order': 'row-major'
 };
 
+// Create the sentinel value ndarray-like object:
+var sentinelValue = {
+    'dtype': 'float64',
+    'data': new Float64Array( [ NaN ] ),
+    'shape': [],
+    'strides': [ 0 ],
+    'offset': 0,
+    'order': 'row-major'
+};
+
 // Perform reduction:
-var out = find( [ x, sentinelValue ], clbk );
+var out = find( [ x, sentinelValue ], isEven );
 // returns 2.0
 ```
 
 The function accepts the following arguments:
 
--   **arrays**: array-like object containing an input ndarray and a zero-dimensional sentinel value ndarray.
+-   **arrays**: array-like object containing an input ndarray and a zero-dimensional ndarray containing a sentinel value which should be returned when no element in an input ndarray passes a test implemented by the predicate function.
 -   **predicate**: predicate function.
 -   **thisArg**: predicate function execution context (_optional_).
 
@@ -118,7 +118,7 @@ To set the predicate function execution context, provide a `thisArg`.
 ```javascript
 var Float64Array = require( '@stdlib/array/float64' );
 
-function clbk( value ) {
+function isEven( value ) {
     this.count += 1;
     return value % 2.0 === 0.0;
 }
@@ -135,16 +135,6 @@ var sx = [ 4, 4, 1 ];
 // Define the index offset:
 var ox = 0;
 
-// Create the sentinel value ndarray-like object:
-var sentinelValue = {
-    'dtype': 'float64',
-    'data': new Float64Array( [ NaN ] ),
-    'shape': [],
-    'strides': [ 0 ],
-    'offset': 0,
-    'order': 'row-major'
-};
-
 // Create the input ndarray-like object:
 var x = {
     'dtype': 'float64',
@@ -155,12 +145,22 @@ var x = {
     'order': 'row-major'
 };
 
+// Create the sentinel value ndarray-like object:
+var sentinelValue = {
+    'dtype': 'float64',
+    'data': new Float64Array( [ NaN ] ),
+    'shape': [],
+    'strides': [ 0 ],
+    'offset': 0,
+    'order': 'row-major'
+};
+
 var ctx = {
     'count': 0
 };
 
 // Test elements:
-var out = find( [ x, sentinelValue ], clbk, ctx );
+var out = find( [ x, sentinelValue ], isEven, ctx );
 // returns 2.0
 
 var count = ctx.count;
@@ -193,7 +193,7 @@ var Float64Array = require( '@stdlib/array/float64' );
 var ndarray2array = require( '@stdlib/ndarray/base/to-array' );
 var find = require( '@stdlib/ndarray/base/find' );
 
-function clbk( value ) {
+function isEven( value ) {
     return value % 2.0 === 0.0;
 }
 
@@ -219,7 +219,7 @@ var sv = {
 };
 console.log( 'Sentinel Value: %d', sv.data[ 0 ] );
 
-var out = find( [ x, sv ], clbk );
+var out = find( [ x, sv ], isEven );
 console.log( out );
 ```
 

diff --git a/lib/node_modules/@stdlib/ndarray/base/find/package.json b/lib/node_modules/@stdlib/ndarray/base/find/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@stdlib/ndarray/base/find",
   "version": "0.0.0",
-  "description": "Return the first element in an ndarray which pass a test implemented by a predicate function.",
+  "description": "Return the first element in an ndarray which passes a test implemented by a predicate function.",
   "license": "Apache-2.0",
   "author": {
     "name": "The Stdlib Authors",