fix: apply suggestions from code review

---
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: passed
  - task: lint_javascript_src
    status: passed
  - 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: passed
  - task: lint_typescript_tests
    status: passed
  - task: lint_license_headers
    status: passed
---

Author: headlessNode

lib/node_modules/@stdlib/ndarray/some-by/README.md

@@ -20,7 +20,7 @@ limitations under the License.
 
 # someBy
 
-> Test whether at least `n` elements in an [`ndarray`][@stdlib/ndarray/ctor] pass a test implemented by a predicate function along one or more dimensions.
+> Test whether at least `n` elements along one or more [`ndarray`][@stdlib/ndarray/ctor] dimensions pass a test implemented by a predicate function.
 
 <section class="intro">
 
@@ -38,32 +38,20 @@ var someBy = require( '@stdlib/ndarray/some-by' );
 
 #### someBy( x, n\[, options], predicate\[, thisArg] )
 
-Tests whether at least `n` elements in an [`ndarray`][@stdlib/ndarray/ctor] pass a test implemented by a predicate function along one or more dimensions.
+Tests whether at least `n` elements along one or more [`ndarray`][@stdlib/ndarray/ctor] dimensions pass a test implemented by a predicate function.
 
 <!-- eslint-disable max-len -->
 
 ```javascript
-var Float64Array = require( '@stdlib/array/float64' );
-var ndarray = require( '@stdlib/ndarray/ctor' );
+var array = require( '@stdlib/ndarray/array' );
 
 function predicate( value ) {
     return value > 0.0;
 }
 
-// Create a data buffer:
-var xbuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
-
-// Define the shape of the input array:
-var sh = [ 3, 1, 2 ];
-
-// Define the array strides:
-var sx = [ 4, 4, 1 ];
-
-// Define the index offset:
-var ox = 1;
-
 // Create an input ndarray:
-var x = new ndarray( 'float64', xbuf, sh, sx, ox, 'row-major' );
+var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ], [ [ 0.0, 6.0 ] ] ] );
+// returns <ndarray>
 
 // Perform reduction:
 var out = someBy( x, 2, predicate );
@@ -76,7 +64,7 @@ console.log( out.get() );
 The function accepts the following arguments:
 
 -   **x**: input [`ndarray`][@stdlib/ndarray/ctor].
--   **n**: number of elements which must pass the test implemented by a predicate function. May be either a scalar or an [`ndarray`][@stdlib/ndarray/ctor].
+-   **n**: number of elements which must pass the test implemented by a predicate function. May be either a scalar or an [`ndarray`][@stdlib/ndarray/ctor]. Must be [broadcast-compatible][@stdlib/ndarray/base/broadcast-shapes] with the non-reduced dimensions of input [`ndarray`][@stdlib/ndarray/ctor]. Must have an integer [data type][@stdlib/ndarray/dtypes].
 -   **options**: function options (_optional_).
 -   **predicate**: predicate function.
 -   **thisArg**: predicate execution context (_optional_).
@@ -88,31 +76,17 @@ The function accepts the following `options`:
 
 By default, the function performs a reduction over all elements in a provided [`ndarray`][@stdlib/ndarray/ctor]. To reduce specific dimensions, set the `dims` option.
 
-<!-- eslint-disable max-len -->
-
 ```javascript
-var Float64Array = require( '@stdlib/array/float64' );
-var ndarray = require( '@stdlib/ndarray/ctor' );
+var array = require( '@stdlib/ndarray/array' );
 var ndarray2array = require( '@stdlib/ndarray/to-array' );
 
 function predicate( value ) {
     return value > 0.0;
 }
 
-// Create a data buffer:
-var xbuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
-
-// Define the shape of the input array:
-var sh = [ 3, 1, 2 ];
-
-// Define the array strides:
-var sx = [ 4, 4, 1 ];
-
-// Define the index offset:
-var ox = 1;
-
 // Create an input ndarray:
-var x = new ndarray( 'float64', xbuf, sh, sx, ox, 'row-major' );
+var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ], [ [ 0.0, 6.0 ] ] ] );
+// returns <ndarray>
 
 var opts = {
     'dims': [ 0, 1 ]
@@ -128,31 +102,17 @@ var v = ndarray2array( out );
 
 By default, the function returns an [`ndarray`][@stdlib/ndarray/ctor] having a shape matching only the non-reduced dimensions of the input [`ndarray`][@stdlib/ndarray/ctor] (i.e., the reduced dimensions are dropped). To include the reduced dimensions as singleton dimensions in the output [`ndarray`][@stdlib/ndarray/ctor], set the `keepdims` option to `true`.
 
-<!-- eslint-disable max-len -->
-
 ```javascript
-var Float64Array = require( '@stdlib/array/float64' );
-var ndarray = require( '@stdlib/ndarray/ctor' );
+var array = require( '@stdlib/ndarray/array' );
 var ndarray2array = require( '@stdlib/ndarray/to-array' );
 
 function predicate( value ) {
     return value > 0.0;
 }
 
-// Create a data buffer:
-var xbuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
-
-// Define the shape of the input array:
-var sh = [ 3, 1, 2 ];
-
-// Define the array strides:
-var sx = [ 4, 4, 1 ];
-
-// Define the index offset:
-var ox = 1;
-
 // Create an input ndarray:
-var x = new ndarray( 'float64', xbuf, sh, sx, ox, 'row-major' );
+var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ], [ [ 0.0, 6.0 ] ] ] );
+// returns <ndarray>
 
 var opts = {
     'dims': [ 0, 1 ],
@@ -164,36 +124,24 @@ var out = someBy( x, 2, opts, predicate );
 // returns <ndarray>
 
 var v = ndarray2array( out );
-// returns [[[ true, true ]]]
+// returns [ [ [ true, true ] ] ]
 ```
 
 To set the predicate function execution context, provide a `thisArg`.
 
-<!-- eslint-disable no-invalid-this, max-len -->
+<!-- eslint-disable no-invalid-this -->
 
 ```javascript
-var Float64Array = require( '@stdlib/array/float64' );
-var ndarray = require( '@stdlib/ndarray/ctor' );
+var array = require( '@stdlib/ndarray/array' );
 
 function predicate( value ) {
     this.count += 1;
     return value > 0.0;
 }
 
-// Create a data buffer:
-var xbuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
-
-// Define the shape of the input array:
-var sh = [ 3, 1, 2 ];
-
-// Define the array strides:
-var sx = [ 4, 4, 1 ];
-
-// Define the index offset:
-var ox = 1;
-
 // Create an input ndarray:
-var x = new ndarray( 'float64', xbuf, sh, sx, ox, 'row-major' );
+var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ], [ [ 0.0, 6.0 ] ] ] );
+// returns <ndarray>
 
 // Create a context object:
 var ctx = {
@@ -213,33 +161,21 @@ var count = ctx.count;
 
 #### someBy.assign( x, n, out\[, options], predicate\[, thisArg] )
 
-Test whether at least `n` elements in an [`ndarray`][@stdlib/ndarray/ctor] pass a test implemented by a predicate function along one or more dimensions and assigns results to a provided output [`ndarray`][@stdlib/ndarray/ctor].
+Tests whether at least `n` elements along one or more [`ndarray`][@stdlib/ndarray/ctor] dimensions pass a test implemented by a predicate function and assigns results to a provided output [`ndarray`][@stdlib/ndarray/ctor].
 
 <!-- eslint-disable max-len -->
 
 ```javascript
-var Float64Array = require( '@stdlib/array/float64' );
-var ndarray = require( '@stdlib/ndarray/ctor' );
+var array = require( '@stdlib/ndarray/array' );
 var empty = require( '@stdlib/ndarray/empty' );
 
 function predicate( value ) {
     return value > 0.0;
 }
 
-// Create a data buffer:
-var xbuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
-
-// Define the shape of the input array:
-var sh = [ 3, 1, 2 ];
-
-// Define the array strides:
-var sx = [ 4, 4, 1 ];
-
-// Define the index offset:
-var ox = 1;
-
 // Create an input ndarray:
-var x = new ndarray( 'float64', xbuf, sh, sx, ox, 'row-major' );
+var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ], [ [ 0.0, 6.0 ] ] ] );
+// returns <ndarray>
 
 // Create an output ndarray:
 var y = empty( [], {
@@ -260,7 +196,7 @@ var v = y.get();
 The function accepts the following arguments:
 
 -   **x**: input [`ndarray`][@stdlib/ndarray/ctor].
--   **n**: number of elements which must pass the test implemented by a predicate function. May be either a scalar or an [`ndarray`][@stdlib/ndarray/ctor].
+-   **n**: number of elements which must pass the test implemented by a predicate function. May be either a scalar or an [`ndarray`][@stdlib/ndarray/ctor]. Must be [broadcast-compatible][@stdlib/ndarray/base/broadcast-shapes] with the non-reduced dimensions of input [`ndarray`][@stdlib/ndarray/ctor]. Must have an integer [data type][@stdlib/ndarray/dtypes].
 -   **out**: output [`ndarray`][@stdlib/ndarray/ctor]. The output [`ndarray`][@stdlib/ndarray/ctor] must have a shape matching the non-reduced dimensions of the input [`ndarray`][@stdlib/ndarray/ctor].
 -   **options**: function options (_optional_).
 -   **predicate**: predicate function.
@@ -272,32 +208,18 @@ The function accepts the following `options`:
 
 By default, the function performs a reduction over all elements in a provided [`ndarray`][@stdlib/ndarray/ctor]. To reduce specific dimensions, set the `dims` option.
 
-<!-- eslint-disable max-len -->
-
 ```javascript
-var Float64Array = require( '@stdlib/array/float64' );
-var ndarray = require( '@stdlib/ndarray/ctor' );
+var array = require( '@stdlib/ndarray/array' );
 var empty = require( '@stdlib/ndarray/empty' );
 var ndarray2array = require( '@stdlib/ndarray/to-array' );
 
 function predicate( value ) {
     return value > 0.0;
 }
 
-// Create a data buffer:
-var xbuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
-
-// Define the shape of the input array:
-var sh = [ 3, 1, 2 ];
-
-// Define the array strides:
-var sx = [ 4, 4, 1 ];
-
-// Define the index offset:
-var ox = 1;
-
 // Create an input ndarray:
-var x = new ndarray( 'float64', xbuf, sh, sx, ox, 'row-major' );
+var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ], [ [ 0.0, 6.0 ] ] ] );
+// returns <ndarray>
 
 // Create an output ndarray:
 var y = empty( [ 2 ], {
@@ -380,6 +302,10 @@ console.log( y.get() );
 
 [@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ctor
 
+[@stdlib/ndarray/base/broadcast-shapes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/broadcast-shapes
+
+[@stdlib/ndarray/dtypes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/dtypes
+
 <!-- <related-links> -->
 
 <!-- </related-links> -->

lib/node_modules/@stdlib/ndarray/some-by/docs/repl.txt

@@ -1,16 +1,17 @@
 
 {{alias}}( x, n[, options], predicate[, thisArg] )
-    Tests whether at least `n` elements in an ndarray pass a test implemented by
-    a predicate function along one or more dimensions.
+    Tests whether at least `n` elements along one or more ndarray dimensions
+    pass a test implemented by a predicate function.
 
     Parameters
     ----------
     x: ndarray
         Input ndarray.
 
-    n: ndarray|any
+    n: ndarray|integer
         Number of elements which must pass the test implemented by a predicate
-        function.
+        function. Must be brodcast compatible with the non-reduced dimensions of
+        input ndarray.
 
     options: Object (optional)
         Function options.
@@ -38,14 +39,9 @@
 
     Examples
     --------
-    > var xbuf = new {{alias:@stdlib/array/float64}}( [ 1.0, 2.0, 3.0, 4.0 ] );
-    > var dt = 'float64';
-    > var sh = [ 2, 2 ];
-    > var sx = [ 2, 1 ];
-    > var ox = 0;
-    > var ord = 'row-major';
-    > var x = {{alias:@stdlib/ndarray/ctor}}( dt, xbuf, sh, sx, ox, ord );
+
     > function f ( v ) { return v > 0.0; };
+    > var x = {{alias:@stdlib/ndarray/array}}( [ [ 1, 2], [ 3, 4 ] ] );
     > var y = {{alias}}( x, 3, f )
     <ndarray>
     > y.get()
@@ -59,17 +55,18 @@
 
 
 {{alias}}.assign( x, n, y[, options], predicate[, thisArg] )
-    Tests whether at least `n` elements in an ndarray pass a test implemented by
-    a predicate function along one or more dimensions.
+    Tests whether at least `n` elements along one or more ndarray dimensions
+    pass a test implemented by a predicate function.
 
     Parameters
     ----------
     x: ndarray
         Input ndarray.
 
-    n: ndarray|any
+    n: ndarray|integer
         Number of elements which must pass the test implemented by a predicate
-        function.
+        function. Must be brodcast compatible with the non-reduced dimensions of
+        input ndarray.
 
     y: ndarray
         Output ndarray. The output shape must match the shape of the non-reduced
@@ -100,15 +97,10 @@
 
     Examples
     --------
-    > var xbuf = new {{alias:@stdlib/array/float64}}( [ 1.0, 2.0, 3.0, 4.0 ] );
-    > var dt = 'float64';
-    > var sh = [ 2, 2 ];
-    > var sx = [ 2, 1 ];
-    > var ox = 0;
-    > var ord = 'row-major';
-    > var x = {{alias:@stdlib/ndarray/ctor}}( dt, xbuf, sh, sx, ox, ord );
-    > var y = {{alias:@stdlib/ndarray/from-scalar}}( false );
+
     > function f ( v ) { return v > 0.0 };
+    > var x = {{alias:@stdlib/ndarray/array}}( [ [ 1, 2], [ 3, 4 ] ] );
+    > var y = {{alias:@stdlib/ndarray/from-scalar}}( false );
     > var out = {{alias}}.assign( x, 3, y, f )
     <ndarray>
     > var bool = ( out === y )