chore: clean-up

---
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: passed
  - 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: kgryte

lib/node_modules/@stdlib/ndarray/flatten-from/README.md

@@ -20,7 +20,7 @@ limitations under the License.
 
 # flattenFrom
 
-> Return a copy of an input [ndarray][@stdlib/ndarray/ctor], where all dimensions of the input [ndarray][@stdlib/ndarray/ctor] are flattened starting from a specified dimension.
+> Return a copy of an input [ndarray][@stdlib/ndarray/ctor] where all dimensions of the input [ndarray][@stdlib/ndarray/ctor] are flattened starting from a specified dimension.
 
 <section class="intro">
 
@@ -38,7 +38,7 @@ var flattenFrom = require( '@stdlib/ndarray/flatten-from' );
 
 #### flattenFrom( x, dim\[, options] )
 
-Returns a copy of an input [ndarray][@stdlib/ndarray/ctor], where all dimensions of the input [ndarray][@stdlib/ndarray/ctor] are flattened starting from a specified dimension.
+Returns a copy of an input [ndarray][@stdlib/ndarray/ctor] where all dimensions of the input [ndarray][@stdlib/ndarray/ctor] are flattened starting from a specified dimension.
 
 ```javascript
 var array = require( '@stdlib/ndarray/array' );
@@ -51,12 +51,12 @@ var y = flattenFrom( x, 1 );
 // returns <ndarray>
 
 var arr = ndarray2array( y );
-// returns [ [ 1, 2 ], [ 3, 4 ], [ 5, 6 ] ]
+// returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
 ```
 
 The function accepts the following arguments:
 
--   **x**: input [ndarray][@stdlib/ndarray/ctor].
+-   **x**: input [ndarray][@stdlib/ndarray/ctor]. Must have one or more dimensions.
 -   **dim**: dimension to start flattening from. If provided an integer less than zero, the dimension index is resolved relative to the last dimension, with the last dimension corresponding to the value `-1`.
 -   **options**: function options (_optional_).
 

lib/node_modules/@stdlib/ndarray/flatten-from/docs/repl.txt

@@ -1,15 +1,15 @@
 
 {{alias}}( x, dim[, options] )
-    Returns a copy of an input ndarray, where all dimensions of the input
-    ndarray are flattened starting from a specified dimension.
+    Returns a copy of an input ndarray where all dimensions of the input ndarray
+    are flattened starting from a specified dimension.
 
     The function always returns a copy of input ndarray data, even when an input
     ndarray already has the desired number of dimensions.
 
     Parameters
     ----------
     x: ndarray
-        Input ndarray.
+        Input ndarray. Must have one or more dimensions.
 
     dim: integer
         Dimension to start flattening from. If provided an integer less than

lib/node_modules/@stdlib/ndarray/flatten-from/docs/types/index.d.ts

@@ -54,7 +54,7 @@ type Options<U> = BaseOptions & {
 };
 
 /**
-* Returns a copy of an input ndarray, where all dimensions of the input ndarray are flattened starting from a specified dimension.
+* Returns a copy of an input ndarray where all dimensions of the input ndarray are flattened starting from a specified dimension.
 *
 * ## Notes
 *
@@ -86,12 +86,12 @@ type Options<U> = BaseOptions & {
 * // returns [ 3, 2 ]
 *
 * var arr = ndarray2array( y );
-* // returns [ [ 1, 2 ], [ 3, 4 ], [ 5, 6 ] ]
+* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
 */
 declare function flattenFrom<T extends ndarray>( x: T, dim: number, options?: BaseOptions ): T;
 
 /**
-* Returns a copy of an input ndarray, where all dimensions of the input ndarray are flattened starting from a specified dimension.
+* Returns a copy of an input ndarray where all dimensions of the input ndarray are flattened starting from a specified dimension.
 *
 * ## Notes
 *
@@ -122,7 +122,7 @@ declare function flattenFrom<T extends ndarray>( x: T, dim: number, options?: Ba
 * // returns [ 3, 2 ]
 *
 * var arr = ndarray2array( y );
-* // returns [ [ 1, 2 ], [ 3, 4 ], [ 5, 6 ] ]
+* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
 */
 declare function flattenFrom<T = unknown, U extends keyof DataTypeMap<T> = 'generic'>( x: typedndarray<T>, dim: number, options: Options<U> ): DataTypeMap<T>[U];
 

lib/node_modules/@stdlib/ndarray/flatten-from/docs/types/test.ts

@@ -130,7 +130,7 @@ import flattenFrom = require( './index' );
 	flattenFrom( zeros( 'generic', [ 2, 2, 2 ], 'row-major' ), 0, ( x: number ): number => x ); // $ExpectError
 }
 
-// The compiler throws an error if the function is provided a second argument with invalid `order` option...
+// The compiler throws an error if the function is provided a second argument with an invalid `order` option...
 {
 	flattenFrom( zeros( 'float64', [ 2, 2, 2 ], 'row-major' ), 0, { 'order': '5' } ); // $ExpectError
 	flattenFrom( zeros( 'float64', [ 2, 2, 2 ], 'row-major' ), 0, { 'order': true } ); // $ExpectError
@@ -154,7 +154,7 @@ import flattenFrom = require( './index' );
 	flattenFrom( zeros( 'generic', [ 2, 2, 2 ], 'row-major' ), 0, { 'order': ( x: number ): number => x } ); // $ExpectError
 }
 
-// The compiler throws an error if the function is provided a second argument with invalid `dtype` option...
+// The compiler throws an error if the function is provided a second argument with an invalid `dtype` option...
 {
 	flattenFrom( zeros( 'float64', [ 2, 2, 2 ], 'row-major' ), 0, { 'dtype': '5' } ); // $ExpectError
 	flattenFrom( zeros( 'float64', [ 2, 2, 2 ], 'row-major' ), 0, { 'dtype': true } ); // $ExpectError

lib/node_modules/@stdlib/ndarray/flatten-from/lib/index.js

@@ -19,7 +19,7 @@
 'use strict';
 
 /**
-* Return a copy of an input ndarray, where all dimensions of the input ndarray are flattened starting from a specified dimension.
+* Return a copy of an input ndarray where all dimensions of the input ndarray are flattened starting from a specified dimension.
 *
 * @module @stdlib/ndarray/flatten-from
 *
@@ -37,7 +37,7 @@
 * // returns <ndarray>
 *
 * var arr = ndarray2array( y );
-* // returns [ [ 1, 2 ], [ 3, 4 ], [ 5, 6 ] ]
+* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
 */
 
 // MODULES //

lib/node_modules/@stdlib/ndarray/flatten-from/lib/main.js

@@ -48,14 +48,14 @@ var COL_MAJOR = 'column-major';
 // MAIN //
 
 /**
-* Returns a copy of an input ndarray, where all dimensions of the input ndarray are flattened starting from a specified dimension.
+* Returns a copy of an input ndarray where all dimensions of the input ndarray are flattened starting from a specified dimension.
 *
 * @param {ndarray} x - input ndarray
-* @param {integer} dim - dimension to start flattening from.
+* @param {integer} dim - dimension to start flattening from
 * @param {Options} [options] - function options
 * @param {string} [options.order='row-major'] - order in which input ndarray elements should be flattened
 * @param {*} [options.dtype] - output ndarray data type
-* @throws {TypeError} first argument must be an ndarray-like object
+* @throws {TypeError} first argument must be an ndarray having one or more dimensions
 * @throws {TypeError} second argument must be an integer
 * @throws {TypeError} options argument must be an object
 * @throws {TypeError} must provide valid options
@@ -72,7 +72,7 @@ var COL_MAJOR = 'column-major';
 * // returns <ndarray>
 *
 * var arr = ndarray2array( y );
-* // returns [ [ 1, 2 ], [ 3, 4 ], [ 5, 6 ] ]
+* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
 *
 * @example
 * var array = require( '@stdlib/ndarray/array' );
@@ -282,7 +282,6 @@ var COL_MAJOR = 'column-major';
 * // returns [ 6.0, 5.0, 4.0, 3.0, 2.0, 1.0 ]
 */
 function flattenFrom( x, dim, options ) {
-	var nargs;
 	var view;
 	var opts;
 	var xsh;
@@ -291,22 +290,23 @@ function flattenFrom( x, dim, options ) {
 	var y;
 
 	if ( !isndarrayLike( x ) ) {
-		throw new TypeError( format( 'invalid argument. First argument must be an ndarray-like object. Value: `%s`.', x ) );
+		throw new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) );
 	}
 	if ( !isInteger( dim ) ) {
 		throw new TypeError( format( 'invalid argument. Second argument must be an integer. Value: `%s`.', dim ) );
 	}
-	nargs = arguments.length;
 	xsh = getShape( x );
-
+	if ( xsh.length < 1 ) {
+		throw new TypeError( format( 'invalid argument. First argument must be an ndarray having one or more dimensions. Number of dimensions: %d.', xsh.length ) );
+	}
 	// Define default options:
 	opts = {
 		'order': ROW_MAJOR,     // by default, flatten in lexicographic order (i.e., trailing dimensions first; e.g., if `x` is a matrix, flatten row-by-row)
 		'dtype': getDType( x )
 	};
 
 	// Resolve function options...
-	if ( nargs > 2 ) {
+	if ( arguments.length > 2 ) {
 		if ( !isPlainObject( options ) ) {
 			throw new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );
 		}
@@ -341,12 +341,12 @@ function flattenFrom( x, dim, options ) {
 	}
 	// Create an output ndarray having contiguous memory:
 	y = emptyLike( x, {
-		'shape': flattenShapeFrom( xsh, dim ),
+		'shape': flattenShapeFrom( xsh, dim ), // note: delegate to `flattenShapeFrom` to handle `dim` normalization
 		'order': opts.order,
 		'dtype': opts.dtype
 	});
 
-	// Create a view on top of output ndarray having the same shape as the input ndarray:
+	// Create a view on top of the output ndarray having the same shape as the input ndarray:
 	st = ( xsh.length > 0 ) ? shape2strides( xsh, opts.order ) : [ 0 ];
 	view = ndarray( opts.dtype, getData( y ), xsh, st, 0, opts.order );
 

lib/node_modules/@stdlib/ndarray/flatten-from/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stdlib/ndarray/flatten-from",
   "version": "0.0.0",
-  "description": "Return a copy of an input ndarray, where all dimensions of the input ndarray are flattened starting from a specified dimension.",
+  "description": "Return a copy of an input ndarray where all dimensions of the input ndarray are flattened starting from a specified dimension.",
   "license": "Apache-2.0",
   "author": {
     "name": "The Stdlib Authors",