chore: clean-up

Author: kgryte

lib/node_modules/@stdlib/ndarray/base/rot90/README.md

@@ -20,7 +20,7 @@ limitations under the License.
 
 # rot90
 
-> Rotate an ndarray 90 degrees in the plane specified by two dimension indices.
+> Rotate an ndarray 90 degrees in a specified plane.
 
 <!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
 
@@ -57,7 +57,7 @@ var y = rot90( x, [ 0, 1 ], 1, false );
 The function accepts the following arguments:
 
 -   **x**: input ndarray.
--   **dims**: dimension indices defining the plane of rotation. Must contain exactly two unique dimension indices.
+-   **dims**: dimension indices defining the plane of rotation. Must contain exactly two unique dimension indices. If a dimension index is provided as an integer less than zero, the dimension index is resolved relative to the last dimension, with the last dimension corresponding to the value `-1`.
 -   **k**: number of times to rotate by 90 degrees. Positive values rotate counterclockwise. Negative values rotate clockwise.
 -   **writable**: boolean indicating whether a returned ndarray should be writable.
 
@@ -71,8 +71,8 @@ The function accepts the following arguments:
 
 ## Notes
 
--   If `k > 0`, the function rotates the ndarray counterclockwise.
--   If `k < 0`, the function rotates the ndarray clockwise.
+-   If `k > 0`, the function rotates the plane from the first specified dimension toward the second specified dimension. This means that, for a two-dimensional ndarray and `dims = [0, 1]`, the function rotates the plane counterclockwise.
+-   If `k < 0`, the function rotates the plane from the second specified dimension toward the first specified dimension. This means that, for a two-dimensional ndarray and `dims = [1, 0]`, the function rotates the plane clockwise.
 -   Each provided dimension index must reside on the interval `[-ndims, ndims-1]`.
 -   The `writable` parameter **only** applies to ndarray constructors supporting **read-only** instances.
 -   The returned ndarray is a **view** of the input ndarray. Accordingly, writing to the original ndarray will **mutate** the returned ndarray and vice versa.

lib/node_modules/@stdlib/ndarray/base/rot90/benchmark/benchmark.js

@@ -31,7 +31,7 @@ var rot90 = require( './../lib' );
 
 // MAIN //
 
-bench( format( '%s::2d,base', pkg ), function benchmark( b ) {
+bench( format( '%s::base:ndims=2', pkg ), function benchmark( b ) {
 	var values;
 	var v;
 	var i;
@@ -59,7 +59,7 @@ bench( format( '%s::2d,base', pkg ), function benchmark( b ) {
 	b.end();
 });
 
-bench( format( '%s::2d,non-base', pkg ), function benchmark( b ) {
+bench( format( '%s::non-base:ndims=2', pkg ), function benchmark( b ) {
 	var values;
 	var v;
 	var i;
@@ -91,7 +91,7 @@ bench( format( '%s::2d,non-base', pkg ), function benchmark( b ) {
 	b.end();
 });
 
-bench( format( '%s::3d,base,dims=[1,2]', pkg ), function benchmark( b ) {
+bench( format( '%s::base:ndims=3,dims=[1,2]', pkg ), function benchmark( b ) {
 	var values;
 	var v;
 	var i;
@@ -119,7 +119,7 @@ bench( format( '%s::3d,base,dims=[1,2]', pkg ), function benchmark( b ) {
 	b.end();
 });
 
-bench( format( '%s::3d,base,dims=[0,2]', pkg ), function benchmark( b ) {
+bench( format( '%s::base:ndims=3,dims=[0,2]', pkg ), function benchmark( b ) {
 	var values;
 	var v;
 	var i;
@@ -147,7 +147,7 @@ bench( format( '%s::3d,base,dims=[0,2]', pkg ), function benchmark( b ) {
 	b.end();
 });
 
-bench( format( '%s::4d,base', pkg ), function benchmark( b ) {
+bench( format( '%s::base:ndims=4', pkg ), function benchmark( b ) {
 	var values;
 	var v;
 	var i;
@@ -175,7 +175,7 @@ bench( format( '%s::4d,base', pkg ), function benchmark( b ) {
 	b.end();
 });
 
-bench( format( '%s::5d,base', pkg ), function benchmark( b ) {
+bench( format( '%s::base:ndims=5', pkg ), function benchmark( b ) {
 	var values;
 	var v;
 	var i;

lib/node_modules/@stdlib/ndarray/base/rot90/docs/repl.txt

@@ -1,10 +1,16 @@
 
 {{alias}}( x, dims, k, writable )
-    Rotates an ndarray 90 degrees in the plane specified by two dimension
-    indices.
+    Rotates an ndarray 90 degrees in a specified plane.
 
-    If `k > 0`, the function rotates the ndarray counterclockwise. If `k < 0`,
-    the function rotates the ndarray clockwise.
+    If `k > 0`, the function rotates the plane from the first specified
+    dimension toward the second specified dimension. This means that, for a two-
+    dimensional ndarray and `dims = [0, 1]`, the function rotates the plane
+    counterclockwise.
+
+    If `k < 0`, the function rotates the plane from the second specified
+    dimension toward the first specified dimension. This means that, for a two-
+    dimensional ndarray and `dims = [1, 0]`, the function rotates the plane
+    clockwise.
 
     Each provided dimension index must reside on the interval [-ndims, ndims-1].
 
@@ -19,7 +25,9 @@
 
     dims: ArrayLikeObject<integer>
         Dimension indices defining the plane of rotation. Must contain exactly
-        two unique dimension indices.
+        two unique dimension indices. If less than zero, an index is resolved
+        relative to the last dimension, with the last dimension corresponding to
+        the value `-1`.
 
     k: integer
         Number of times to rotate by 90 degrees.

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

@@ -24,12 +24,12 @@ import { typedndarray } from '@stdlib/types/ndarray';
 import { Collection } from '@stdlib/types/array';
 
 /**
-* Rotates an ndarray 90 degrees in the plane specified by two dimension indices.
+* Rotates an ndarray 90 degrees in a specified plane.
 *
 * ## Notes
 *
-* -   If `k > 0`, the function rotates the ndarray counterclockwise.
-* -   If `k < 0`, the function rotates the ndarray clockwise.
+* -   If `k > 0`, the function rotates the plane from the first specified dimension toward the second specified dimension. This means that, for a two-dimensional ndarray and `dims = [0, 1]`, the function rotates the plane counterclockwise.
+* -   If `k < 0`, the function rotates the plane from the second specified dimension toward the first specified dimension. This means that, for a two-dimensional ndarray and `dims = [1, 0]`, the function rotates the plane clockwise.
 * -   Each provided dimension index must reside on the interval `[-ndims, ndims-1]`.
 *
 * @param x - input array

lib/node_modules/@stdlib/ndarray/base/rot90/docs/types/test.ts

@@ -41,7 +41,7 @@ import rot90 = require( './index' );
 	rot90( zeros( 'generic', sh, ord ), [ 0, 1 ], 1, false ); // $ExpectType genericndarray<number>
 }
 
-// The compiler throws an error if the function is provided a first argument which is not an ndarray having a recognized/supported data type...
+// The compiler throws an error if the function is provided a first argument which is not an ndarray...
 {
 	rot90( '10', [ 0, 1 ], 1, false ); // $ExpectError
 	rot90( 10, [ 0, 1 ], 1, false ); // $ExpectError

lib/node_modules/@stdlib/ndarray/base/rot90/examples/index.js

@@ -50,7 +50,7 @@ y = rot90( x, [ 0, 1 ], -1, false );
 console.log( ndarray2array( y ) );
 // => [ [ 4, 1 ], [ 5, 2 ], [ 6, 3 ] ]
 
-// Reverse the rotation direction by reversing the dims order:
+// Reverse the rotation direction by reversing the dimension order:
 y = rot90( x, [ 1, 0 ], 1, false );
 console.log( ndarray2array( y ) );
 // => [ [ 4, 1 ], [ 5, 2 ], [ 6, 3 ] ]

lib/node_modules/@stdlib/ndarray/base/rot90/lib/index.js

@@ -19,7 +19,7 @@
 'use strict';
 
 /**
-* Rotate an ndarray 90 degrees in the plane specified by two dimension indices.
+* Rotate an ndarray 90 degrees in a specified plane.
 *
 * @module @stdlib/ndarray/base/rot90
 *

lib/node_modules/@stdlib/ndarray/base/rot90/lib/main.js

@@ -34,12 +34,12 @@ var format = require( '@stdlib/string/format' );
 // MAIN //
 
 /**
-* Rotates an ndarray 90 degrees in the plane specified by two dimension indices.
+* Rotates an ndarray 90 degrees in a specified plane.
 *
 * ## Notes
 *
-* -   If `k > 0`, the function rotates the ndarray counterclockwise.
-* -   If `k < 0`, the function rotates the ndarray clockwise.
+* -   If `k > 0`, the function rotates the plane from the first specified dimension toward the second specified dimension. This means that, for a two-dimensional ndarray and `dims = [0, 1]`, the function rotates the plane counterclockwise.
+* -   If `k < 0`, the function rotates the plane from the second specified dimension toward the first specified dimension. This means that, for a two-dimensional ndarray and `dims = [1, 0]`, the function rotates the plane clockwise.
 * -   Each provided dimension index must reside on the interval `[-ndims, ndims-1]`.
 *
 * @param {ndarray} x - input array

lib/node_modules/@stdlib/ndarray/base/rot90/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stdlib/ndarray/base/rot90",
   "version": "0.0.0",
-  "description": "Rotate an ndarray 90 degrees in the plane specified by two dimension indices.",
+  "description": "Rotate an ndarray 90 degrees in a specified plane.",
   "license": "Apache-2.0",
   "author": {
     "name": "The Stdlib Authors",

lib/node_modules/@stdlib/ndarray/base/rot90/test/test.js

@@ -615,7 +615,7 @@ tape( 'the function supports a `writable` parameter', function test( t ) {
 	t.end();
 });
 
-tape( 'the function supports a non-zero offset', function test( t ) {
+tape( 'the function supports ndarrays having a non-zero offset', function test( t ) {
 	var expected;
 	var arr;
 	var buf;
@@ -647,7 +647,7 @@ tape( 'the function supports a non-zero offset', function test( t ) {
 	t.end();
 });
 
-tape( 'the function supports rotating four times in the same plane, returning the original arrangement', function test( t ) {
+tape( 'the function returns the original arrangement when rotating four times in the same plane', function test( t ) {
 	var expected;
 	var arr;
 	var buf;