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: na
  - task: lint_repl_help
    status: passed
  - task: lint_javascript_src
    status: passed
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: passed
  - task: lint_javascript_tests
    status: passed
  - task: lint_javascript_benchmarks
    status: passed
  - 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/blas/ext/join-between/README.md

@@ -30,60 +30,56 @@ limitations under the License.
 var joinBetween = require( '@stdlib/blas/ext/join-between' );
 ```
 
-#### joinBetween( x\[, options] )
+#### joinBetween( x, separators\[, options] )
 
 Returns an [ndarray][@stdlib/ndarray/ctor] created by joining elements using specified separators for each pair of consecutive elements along one or more [ndarray][@stdlib/ndarray/ctor] dimensions.
 
 ```javascript
 var array = require( '@stdlib/ndarray/array' );
+var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
 
 // Create an input ndarray:
 var x = array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
 // returns <ndarray>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
 
+// Create a separators ndarray:
+var sep = scalar2ndarray( ',', {
+    'dtype': 'generic'
+});
+
 // Perform operation:
-var out = joinBetween( x );
+var out = joinBetween( x, sep );
 // returns <ndarray>[ '1,2,3,4,5,6' ]
 ```
 
 The function has the following parameters:
 
 -   **x**: input [ndarray][@stdlib/ndarray/ctor].
+-   **separators**: separators [ndarray][@stdlib/ndarray/ctor]. Must be [broadcast-compatible][@stdlib/ndarray/base/broadcast-shapes] with the shape consisting of the complement of the shape defined by `options.dims` followed by `N-1` where `N` is the number of elements along the reduced dimensions.
 -   **options**: function options (_optional_).
 
 The function accepts the following options:
 
--   **prefix**: prefix to prepend to each joined string. Default: `''`.
--   **suffix**: suffix to append to each joined string. Default: `''`.
--   **separators**: separators. Must be an array-like object. When provided an array containing a single element, the same separator is used between all consecutive pairs of elements. When containing multiple elements, each element specifies the separator to use between consecutive pairs, and the number of elements must equal one less than the number of elements along the reduced dimensions. Default: `[ ',' ]`.
+-   **prefix**: prefix to prepend to each joined string. May be a scalar value or an [ndarray][@stdlib/ndarray/ctor] which is [broadcast-compatible][@stdlib/ndarray/base/broadcast-shapes] with the complement of the shape defined by `options.dims`. Default: `''`.
+-   **suffix**: suffix to append to each joined string. May be a scalar value or an [ndarray][@stdlib/ndarray/ctor] which is [broadcast-compatible][@stdlib/ndarray/base/broadcast-shapes] with the complement of the shape defined by `options.dims`. Default: `''`.
 -   **dims**: list of dimensions over which to perform operation. If not provided, the function performs the operation over all elements in a provided input [ndarray][@stdlib/ndarray/ctor].
 -   **keepdims**: boolean indicating whether the reduced dimensions should be included in the returned [ndarray][@stdlib/ndarray/ctor] as singleton dimensions. Default: `false`.
 
-By default, the function joins [ndarray][@stdlib/ndarray/ctor] elements by using `,` as a separator between all consecutive pairs of elements. To perform the operation with a different separator, provide a `separators` option.
+To specify a prefix and suffix to prepend and append to each joined string, provide `prefix` and `suffix` options.
 
 ```javascript
 var array = require( '@stdlib/ndarray/array' );
+var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
 
 var x = array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
 
-var out = joinBetween( x, {
-    'separators': [ '|' ]
+var sep = scalar2ndarray( ', ', {
+    'dtype': 'generic'
 });
-// returns <ndarray>[ '1|2|3|4|5|6' ]
-```
 
-To specify a prefix and suffix to prepend and append to each joined string, provide `prefix` and `suffix` options.
-
-```javascript
-var array = require( '@stdlib/ndarray/array' );
-
-var x = array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
-// returns <ndarray>[ 1, 2, 3, 4, 5, 6 ]
-
-var out = joinBetween( x, {
+var out = joinBetween( x, sep, {
     'prefix': '[ ',
-    'suffix': ' ]',
-    'separators': [ ', ' ]
+    'suffix': ' ]'
 });
 // returns <ndarray>[ '[ 1, 2, 3, 4, 5, 6 ]' ]
 ```
@@ -92,32 +88,45 @@ By default, the function performs the operation over all elements in a provided
 
 ```javascript
 var array = require( '@stdlib/ndarray/array' );
+var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
 
 var x = array( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] );
-// returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
 
-var out = joinBetween( x, {
+var sep = scalar2ndarray( ',', {
+    'dtype': 'generic'
+});
+
+var out = joinBetween( x, sep, {
     'dims': [ 0 ]
 });
 // returns <ndarray>[ '1,3', '2,4' ]
+
+out = joinBetween( x, sep, {
+    'dims': [ 1 ]
+});
+// returns <ndarray>[ '1,2', '3,4' ]
 ```
 
 By default, the function excludes reduced dimensions from the output [ndarray][@stdlib/ndarray/ctor]. To include the reduced dimensions as singleton dimensions, set the `keepdims` option to `true`.
 
 ```javascript
 var array = require( '@stdlib/ndarray/array' );
+var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
 
 var x = array( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] );
-// returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
 
-var out = joinBetween( x, {
+var sep = scalar2ndarray( ',', {
+    'dtype': 'generic'
+});
+
+var out = joinBetween( x, sep, {
     'dims': [ 0 ],
     'keepdims': true
 });
 // returns <ndarray>[ [ '1,3', '2,4' ] ]
 ```
 
-#### joinBetween.assign( x, out\[, options] )
+#### joinBetween.assign( x, separators, out\[, options] )
 
 Joins elements of an input [ndarray][@stdlib/ndarray/ctor] using specified separators for each pair of consecutive elements along one or more [ndarray][@stdlib/ndarray/ctor] dimensions and assigns results to a provided output [ndarray][@stdlib/ndarray/ctor].
 
@@ -126,11 +135,14 @@ var array = require( '@stdlib/ndarray/array' );
 var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
 
 var x = array( [ 1.0, 2.0, 3.0, 4.0 ] );
+var sep = scalar2ndarray( ',', {
+    'dtype': 'generic'
+});
 var y = scalar2ndarray( '', {
     'dtype': 'generic'
 });
 
-var out = joinBetween.assign( x, y );
+var out = joinBetween.assign( x, sep, y );
 // returns <ndarray>[ '1,2,3,4' ]
 
 var bool = ( out === y );
@@ -140,14 +152,14 @@ var bool = ( out === y );
 The method has the following parameters:
 
 -   **x**: input [ndarray][@stdlib/ndarray/ctor].
+-   **separators**: separators [ndarray][@stdlib/ndarray/ctor]. Must be [broadcast-compatible][@stdlib/ndarray/base/broadcast-shapes] with the shape consisting of the complement of the shape defined by `options.dims` followed by `N-1` where `N` is the number of elements along the reduced dimensions.
 -   **out**: output [ndarray][@stdlib/ndarray/ctor].
 -   **options**: function options (_optional_).
 
 The method accepts the following options:
 
--   **prefix**: prefix to prepend to each joined string. Default: `''`.
--   **suffix**: suffix to append to each joined string. Default: `''`.
--   **separators**: separators. Must be an array-like object. When provided an array containing a single element, the same separator is used between all consecutive pairs of elements. When containing multiple elements, each element specifies the separator to use between consecutive pairs, and the number of elements must equal one less than the number of elements along the reduced dimensions. Default: `[ ',' ]`.
+-   **prefix**: prefix to prepend to each joined string. May be a scalar value or an [ndarray][@stdlib/ndarray/ctor] which is [broadcast-compatible][@stdlib/ndarray/base/broadcast-shapes] with the complement of the shape defined by `options.dims`. Default: `''`.
+-   **suffix**: suffix to append to each joined string. May be a scalar value or an [ndarray][@stdlib/ndarray/ctor] which is [broadcast-compatible][@stdlib/ndarray/base/broadcast-shapes] with the complement of the shape defined by `options.dims`. Default: `''`.
 -   **dims**: list of dimensions over which to perform operation. If not provided, the function performs the operation over all elements in a provided input [ndarray][@stdlib/ndarray/ctor].
 
 </section>
@@ -159,7 +171,6 @@ The method accepts the following options:
 ## Notes
 
 -   Setting the `keepdims` option to `true` can be useful when wanting to ensure that the output [ndarray][@stdlib/ndarray/ctor] is [broadcast-compatible][@stdlib/ndarray/base/broadcast-shapes] with ndarrays having the same shape as the input [ndarray][@stdlib/ndarray/ctor].
--   When providing an array containing multiple separators, each element specifies the separator to use between consecutive pairs. The same separators are used for every complement position when reducing specific dimensions.
 
 </section>
 
@@ -172,18 +183,22 @@ The method accepts the following options:
 <!-- eslint no-undef: "error" -->
 
 ```javascript
+var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
 var uniform = require( '@stdlib/random/uniform' );
 var ndarray2array = require( '@stdlib/ndarray/to-array' );
 var joinBetween = require( '@stdlib/blas/ext/join-between' );
 
 var x = uniform( [ 5, 2 ], 0.0, 20.0 );
 console.log( ndarray2array( x ) );
 
-var out = joinBetween( x, {
+var sep = scalar2ndarray( ', ', {
+    'dtype': 'generic'
+});
+
+var out = joinBetween( x, sep, {
     'dims': [ -1 ],
     'prefix': '[ ',
-    'suffix': ' ]',
-    'separators': [ ', ' ]
+    'suffix': ' ]'
 });
 console.log( ndarray2array( out ) );
 ```

lib/node_modules/@stdlib/blas/ext/join-between/benchmark/benchmark.assign.js

@@ -21,11 +21,11 @@
 // MODULES //
 
 var bench = require( '@stdlib/bench' );
-var isnan = require( '@stdlib/math/base/assert/is-nan' );
+var isString = require( '@stdlib/assert/is-string' ).isPrimitive;
 var pow = require( '@stdlib/math/base/special/pow' );
-var uniform = require( '@stdlib/random/array/uniform' );
+var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
+var uniform = require( '@stdlib/random/uniform' );
 var empty = require( '@stdlib/ndarray/empty' );
-var ndarray = require( '@stdlib/ndarray/base/ctor' );
 var format = require( '@stdlib/string/format' );
 var pkg = require( './../package.json' ).name;
 var joinBetween = require( './../lib' );
@@ -48,11 +48,15 @@ var options = {
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
+	var sep;
 	var out;
 	var x;
 
-	x = uniform( len, -50.0, 50.0, options );
-	x = new ndarray( options.dtype, x, [ len ], [ 1 ], 0, 'row-major' );
+	x = uniform( [ len ], -50.0, 50.0, options );
+
+	sep = scalar2ndarray( ',', {
+		'dtype': 'generic'
+	});
 
 	out = empty( [], {
 		'dtype': 'generic'
@@ -72,14 +76,14 @@ function createBenchmark( len ) {
 
 		b.tic();
 		for ( i = 0; i < b.iterations; i++ ) {
-			o = joinBetween.assign( x, out );
+			o = joinBetween.assign( x, sep, out );
 			if ( typeof o !== 'object' ) {
 				b.fail( 'should return an ndarray' );
 			}
 		}
 		b.toc();
-		if ( isnan( o.get() ) ) {
-			b.fail( 'should not return NaN' );
+		if ( !isString( o.get() ) ) {
+			b.fail( 'should return a string' );
 		}
 		b.pass( 'benchmark finished' );
 		b.end();

lib/node_modules/@stdlib/blas/ext/join-between/benchmark/benchmark.js

@@ -21,10 +21,10 @@
 // MODULES //
 
 var bench = require( '@stdlib/bench' );
-var isnan = require( '@stdlib/math/base/assert/is-nan' );
+var isString = require( '@stdlib/assert/is-string' ).isPrimitive;
 var pow = require( '@stdlib/math/base/special/pow' );
-var uniform = require( '@stdlib/random/array/uniform' );
-var ndarray = require( '@stdlib/ndarray/base/ctor' );
+var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
+var uniform = require( '@stdlib/random/uniform' );
 var format = require( '@stdlib/string/format' );
 var pkg = require( './../package.json' ).name;
 var joinBetween = require( './../lib' );
@@ -47,8 +47,14 @@ var options = {
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var x = uniform( len, -50.0, 50.0, options );
-	x = new ndarray( options.dtype, x, [ len ], [ 1 ], 0, 'row-major' );
+	var sep;
+	var x;
+
+	x = uniform( [ len ], -50.0, 50.0, options );
+
+	sep = scalar2ndarray( ',', {
+		'dtype': 'generic'
+	});
 
 	return benchmark;
 
@@ -64,14 +70,14 @@ function createBenchmark( len ) {
 
 		b.tic();
 		for ( i = 0; i < b.iterations; i++ ) {
-			o = joinBetween( x );
+			o = joinBetween( x, sep );
 			if ( typeof o !== 'object' ) {
 				b.fail( 'should return an ndarray' );
 			}
 		}
 		b.toc();
-		if ( isnan( o.get() ) ) {
-			b.fail( 'should not return NaN' );
+		if ( !isString( o.get() ) ) {
+			b.fail( 'should return a string' );
 		}
 		b.pass( 'benchmark finished' );
 		b.end();