refactor: 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: passed
  - 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: headlessNode

lib/node_modules/@stdlib/ndarray/shift/README.md

@@ -20,7 +20,7 @@ limitations under the License.
 
 # shift
 
-> Return an array containing a read-only truncated view of an input [`ndarray`][@stdlib/ndarray/ctor] and a read-only view of the first element(s) along a specific dimension.
+> Return an array containing a read-only truncated view of an input [`ndarray`][@stdlib/ndarray/ctor] and a read-only view of the first element(s) along a specified dimension.
 
 <!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
 
@@ -42,24 +42,17 @@ var shift = require( '@stdlib/ndarray/shift' );
 
 #### shift( x\[, options] )
 
-Returns an array containing a **read-only** truncated view of an input [`ndarray`][@stdlib/ndarray/ctor] and a **read-only** view of the first element(s) along a specific dimension.
+Returns an array containing a **read-only** truncated view of an input [`ndarray`][@stdlib/ndarray/ctor] and a **read-only** view of the first element(s) along a specified dimension.
 
 ```javascript
-var ndarray = require( '@stdlib/ndarray/ctor' );
-var getShape = require( '@stdlib/ndarray/shape' );
+var array = require( '@stdlib/ndarray/array' );
 var ndarray2array = require( '@stdlib/ndarray/to-array' );
 
-var buffer = [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ];
-var shape = [ 3, 2 ];
-var strides = [ 2, 1 ];
-var offset = 0;
-
-var x = ndarray( 'generic', buffer, shape, strides, offset, 'row-major' );
+var x = array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ], {
+    'shape': [ 3, 2 ]
+});
 // returns <ndarray>
 
-var sh = getShape( x );
-// returns [ 3, 2 ]
-
 var arr = ndarray2array( x );
 // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
 
@@ -82,24 +75,17 @@ The function supports the following `options`:
 
 -   **dim**: dimension along which to perform the operation. 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`. Default: `0`.
 
-By default, the function performs operation along the first dimension of the input [`ndarray`][@stdlib/ndarray/ctor]. To perform operation along a desired dimension, provide the `dim` option.
+By default, the function performs operation along the first dimension of the input [`ndarray`][@stdlib/ndarray/ctor]. To perform operation along a specific dimension, provide the `dim` option.
 
 ```javascript
-var ndarray = require( '@stdlib/ndarray/ctor' );
-var getShape = require( '@stdlib/ndarray/shape' );
+var array = require( '@stdlib/ndarray/array' );
 var ndarray2array = require( '@stdlib/ndarray/to-array' );
 
-var buffer = [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ];
-var shape = [ 3, 2 ];
-var strides = [ 2, 1 ];
-var offset = 0;
-
-var x = ndarray( 'generic', buffer, shape, strides, offset, 'row-major' );
+var x = array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ], {
+    'shape': [ 3, 2 ]
+});
 // returns <ndarray>
 
-var sh = getShape( x );
-// returns [ 3, 2 ]
-
 var arr = ndarray2array( x );
 // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
 
@@ -140,20 +126,17 @@ arr = ndarray2array( y[ 1 ] );
 ```javascript
 var array = require( '@stdlib/ndarray/array' );
 var ndarray2array = require( '@stdlib/ndarray/to-array' );
-var zeroTo = require( '@stdlib/array/base/zero-to' );
-var shift = require( '@stdlib/ndarray/shift' );
+var zeroTo = require( '@stdlib/array/zero-to' );
+var pop = require( '@stdlib/ndarray/pop' );
 
-// Create a linear ndarray buffer:
-var buf = zeroTo( 27 );
-
-// Create an ndarray which is a stack of three 3x3 matrices:
-var x = array( buf, {
+// Create an ndarray:
+var x = array( zeroTo( 27 ), {
     'shape': [ 3, 3, 3 ]
 });
+console.log( ndarray2array( x ) );
 
-// Perform the operation:
+// Remove the first stack from a stack of matrices:
 var y = shift( x );
-// returns [ <ndarray>, <ndarray> ]
 
 console.log( ndarray2array( y[ 0 ] ) );
 console.log( ndarray2array( y[ 1 ] ) );

lib/node_modules/@stdlib/ndarray/shift/docs/repl.txt

@@ -1,7 +1,7 @@
 
 {{alias}}( x[, options] )
     Returns an array containing a read-only truncated view of an input ndarray
-    and a read-only view of the first element(s) along a specific dimension.
+    and a read-only view of the first element(s) along a specified dimension.
 
     Parameters
     ----------
@@ -21,7 +21,7 @@
     -------
     out: Array<ndarray>
         An array containing a read-only truncated view of an input ndarray and a
-        read-only view of the first element(s) along a specific dimension.
+        read-only view of the first element(s) along a specified dimension.
 
     Examples
     --------

lib/node_modules/@stdlib/ndarray/shift/docs/types/index.d.ts

@@ -33,7 +33,7 @@ interface Options {
 }
 
 /**
-* Returns an array containing a read-only truncated view of an input ndarray and a read-only view of the first element(s) along a specific dimension.
+* Returns an array containing a read-only truncated view of an input ndarray and a read-only view of the first element(s) along a specified dimension.
 *
 * @param x - input array
 * @param options - function options

lib/node_modules/@stdlib/ndarray/shift/examples/index.js

@@ -20,19 +20,16 @@
 
 var array = require( '@stdlib/ndarray/array' );
 var ndarray2array = require( '@stdlib/ndarray/to-array' );
-var zeroTo = require( '@stdlib/array/base/zero-to' );
+var zeroTo = require( '@stdlib/array/zero-to' );
 var shift = require( './../lib' );
 
-// Create a linear ndarray buffer:
-var buf = zeroTo( 27 );
-
 // Create an ndarray:
-var x = array( buf, {
+var x = array( zeroTo( 27 ), {
 	'shape': [ 3, 3, 3 ]
 });
 console.log( ndarray2array( x ) );
 
-// Perform the operation:
+// Remove the first stack from a stack of matrices:
 var y = shift( x );
 
 console.log( ndarray2array( y[ 0 ] ) );

lib/node_modules/@stdlib/ndarray/shift/lib/index.js

@@ -19,7 +19,7 @@
 'use strict';
 
 /**
-* Return an array containing a read-only truncated view of an input ndarray and a read-only view of the first element(s) along a specific dimension.
+* Return an array containing a read-only truncated view of an input ndarray and a read-only view of the first element(s) along a specified dimension.
 *
 * @module @stdlib/ndarray/shift
 *

lib/node_modules/@stdlib/ndarray/shift/lib/main.js

@@ -31,15 +31,16 @@ var format = require( '@stdlib/string/format' );
 // MAIN //
 
 /**
-* Returns an array containing a read-only truncated view of an input ndarray and a read-only view of the first element(s) along a specific dimension.
+* Returns an array containing a read-only truncated view of an input ndarray and a read-only view of the first element(s) along a specified dimension.
 *
 * @param {ndarray} x - input array
 * @param {Object} [options] - function options
 * @param {integer} [options.dim=0] - dimension along which to perform the operation
 * @throws {TypeError} first argument must be an ndarray having one or more dimensions
+* @throws {RangeError} dimension index exceeds the number of dimensions
 * @throws {TypeError} options argument must be an object
 * * @throws {TypeError} must provide valid options
-* @returns {Array<ndarray>} a list of ndarrays
+* @returns {Array<ndarray>} a list of ndarray views
 *
 * @example
 * var ndarray = require( '@stdlib/ndarray/ctor' );
@@ -82,7 +83,7 @@ function shift( x ) {
 		}
 		if ( hasOwnProp( options, 'dim' ) ) {
 			if ( !isInteger( options.dim ) ) {
-				throw new TypeError( format( 'invalid option. `%s` option must be a boolean. Option: `%s`.', 'strict', options.strict ) );
+				throw new TypeError( format( 'invalid option. `%s` option must be an integer. Option: `%s`.', 'strict', options.strict ) );
 			}
 			opts.dim = options.dim;
 		}

lib/node_modules/@stdlib/ndarray/shift/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stdlib/ndarray/shift",
   "version": "0.0.0",
-  "description": "Return an array containing a read-only truncated view of an input ndarray and a read-only view of the first element(s) along a specific dimension.",
+  "description": "Return an array containing a read-only truncated view of an input ndarray and a read-only view of the first element(s) along a specified dimension.",
   "license": "Apache-2.0",
   "author": {
     "name": "The Stdlib Authors",

lib/node_modules/@stdlib/ndarray/shift/test/test.js

@@ -246,6 +246,20 @@ tape( 'the function returns an array containing ndarrays (ndims=1, options)', fu
 	t.deepEqual( ndarray2array( actual[0] ), [ 1, 2, 3, 4, 5 ], 'returns expected value' );
 	t.deepEqual( ndarray2array( actual[1] ), [ 0 ], 'returns expected value' );
 
+	opts = {
+		'dim': -1
+	};
+	actual = shift( x, opts );
+
+	t.strictEqual( isndarrayLike( actual[0] ), true, 'returns expected value' );
+	t.strictEqual( isndarrayLike( actual[1] ), true, 'returns expected value' );
+	t.strictEqual( isReadOnly( actual[0] ), true, 'returns expected value' );
+	t.strictEqual( isReadOnly( actual[1] ), true, 'returns expected value' );
+	t.deepEqual( getShape( actual[0] ), [ 5 ], 'returns expected value' );
+	t.deepEqual( getShape( actual[1] ), [ 1 ], 'returns expected value' );
+	t.deepEqual( ndarray2array( actual[0] ), [ 1, 2, 3, 4, 5 ], 'returns expected value' );
+	t.deepEqual( ndarray2array( actual[1] ), [ 0 ], 'returns expected value' );
+
 	t.end();
 });
 
@@ -298,11 +312,25 @@ tape( 'the function returns an array containing ndarrays (ndims=2, options)', fu
 
 	x = new ndarray( 'float64', buf, sh, st, o, ord );
 	opts = {
-		'dim': 1
+		'dim': 0
 	};
 
 	actual = shift( x, opts );
 
+	t.strictEqual( isndarrayLike( actual[0] ), true, 'returns expected value' );
+	t.strictEqual( isndarrayLike( actual[1] ), true, 'returns expected value' );
+	t.strictEqual( isReadOnly( actual[0] ), true, 'returns expected value' );
+	t.strictEqual( isReadOnly( actual[1] ), true, 'returns expected value' );
+	t.deepEqual( getShape( actual[0] ), [ 1, 4 ], 'returns expected value' );
+	t.deepEqual( getShape( actual[1] ), [ 1, 4 ], 'returns expected value' );
+	t.deepEqual( ndarray2array( actual[0] ), [ [ 4, 5, 6, 7] ], 'returns expected value' );
+	t.deepEqual( ndarray2array( actual[1] ), [ [ 0, 1, 2, 3 ] ], 'returns expected value' );
+
+	opts = {
+		'dim': -1
+	};
+	actual = shift( x, opts );
+
 	t.strictEqual( isndarrayLike( actual[0] ), true, 'returns expected value' );
 	t.strictEqual( isndarrayLike( actual[1] ), true, 'returns expected value' );
 	t.strictEqual( isReadOnly( actual[0] ), true, 'returns expected value' );
@@ -387,10 +415,24 @@ tape( 'the function returns an array containing ndarrays (ndims=3, options)', fu
 	*];
 	*/
 	x = new ndarray( 'float64', buf, sh, st, o, ord );
+
 	opts = {
-		'dim': 1
+		'dim': 0
 	};
+	actual = shift( x, opts );
 
+	t.strictEqual( isndarrayLike( actual[0] ), true, 'returns expected value' );
+	t.strictEqual( isndarrayLike( actual[1] ), true, 'returns expected value' );
+	t.strictEqual( isReadOnly( actual[0] ), true, 'returns expected value' );
+	t.strictEqual( isReadOnly( actual[1] ), true, 'returns expected value' );
+	t.deepEqual( getShape( actual[0] ), [ 1, 2, 2 ], 'returns expected value' );
+	t.deepEqual( getShape( actual[1] ), [ 1, 2, 2 ], 'returns expected value' );
+	t.deepEqual( ndarray2array( actual[0] ), [ [ [ 4, 5 ], [ 6, 7 ] ] ], 'returns expected value' );
+	t.deepEqual( ndarray2array( actual[1] ), [ [ [ 0, 1 ], [ 2, 3 ] ] ], 'returns expected value' );
+
+	opts = {
+		'dim': -2
+	};
 	actual = shift( x, opts );
 
 	t.strictEqual( isndarrayLike( actual[0] ), true, 'returns expected value' );
@@ -468,9 +510,22 @@ tape( 'the function returns empty views if provided an empty array (ndims=2, opt
 	sh = [ 2, 0 ];
 	x = new ndarray( 'float64', buf, sh, st, o, ord );
 	opts = {
-		'dim': 1
+		'dim': 0
 	};
+	actual = shift( x, opts );
 
+	t.strictEqual( isndarrayLike( actual[0] ), true, 'returns expected value' );
+	t.strictEqual( isndarrayLike( actual[1] ), true, 'returns expected value' );
+	t.strictEqual( isReadOnly( actual[0] ), true, 'returns expected value' );
+	t.strictEqual( isReadOnly( actual[1] ), true, 'returns expected value' );
+	t.deepEqual( getShape( actual[0] ), [ 1, 0 ], 'returns expected value' );
+	t.deepEqual( getShape( actual[1] ), [ 1, 0 ], 'returns expected value' );
+	t.deepEqual( ndarray2array( actual[0] ), [], 'returns expected value' );
+	t.deepEqual( ndarray2array( actual[1] ), [], 'returns expected value' );
+
+	opts = {
+		'dim': -1
+	};
 	actual = shift( x, opts );
 
 	t.strictEqual( isndarrayLike( actual[0] ), true, 'returns expected value' );