Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -426,6 +426,7 @@ A total of 17 issues were closed in this release:
 
 <details>
 
+-   [`2bec349`](https://github.com/stdlib-js/stdlib/commit/2bec349f607cc8fd3a4d05e6aca72c73b734c888) - **chore:** clean-up descriptions and comments _(by Athan Reines)_
 -   [`0367f1d`](https://github.com/stdlib-js/stdlib/commit/0367f1d22be37c646f5a354c6c34ee3a755b3aeb) - **refactor:** fix error messages and use string interpolation _(by Athan Reines)_
 -   [`f50db5b`](https://github.com/stdlib-js/stdlib/commit/f50db5b43e51607e188f38bd6fab7d0ad5098110) - **docs:** update namespace table of contents [(#7152)](https://github.com/stdlib-js/stdlib/pull/7152) _(by stdlib-bot)_
 -   [`4f41317`](https://github.com/stdlib-js/stdlib/commit/4f413178393495c6fb1a25d9ebcfd90132013ea5) - **docs:** update comments _(by Athan Reines)_

base/map/README.md

@@ -81,7 +81,7 @@ var y = {
     'order': 'row-major'
 };
 
-// Apply the map function:
+// Apply function:
 map( [ x, y ], scale );
 
 console.log( y.data );

base/map/docs/types/index.d.ts

@@ -28,15 +28,15 @@ import { typedndarray } from '@stdlib/types/ndarray';
 *
 * @returns output value
 */
-type Nullary<U, V> = ( this: V ) => U;
+type Nullary<U, ThisArg> = ( this: ThisArg ) => U;
 
 /**
 * Callback invoked for each ndarray element.
 *
 * @param value - current array element
 * @returns output value
 */
-type Unary<T, U, V> = ( this: V, value: T ) => U;
+type Unary<T, U, ThisArg> = ( this: ThisArg, value: T ) => U;
 
 /**
 * Callback invoked for each ndarray element.
@@ -45,7 +45,7 @@ type Unary<T, U, V> = ( this: V, value: T ) => U;
 * @param indices - current array element indices
 * @returns output value
 */
-type Binary<T, U, V> = ( this: V, value: T, indices: Array<number> ) => U;
+type Binary<T, U, ThisArg> = ( this: ThisArg, value: T, indices: Array<number> ) => U;
 
 /**
 * Callback invoked for each ndarray element.
@@ -55,7 +55,7 @@ type Binary<T, U, V> = ( this: V, value: T, indices: Array<number> ) => U;
 * @param arr - input array
 * @returns output value
 */
-type Ternary<T, U, V> = ( this: V, value: T, indices: Array<number>, arr: typedndarray<T> ) => U;
+type Ternary<T, U, ThisArg> = ( this: ThisArg, value: T, indices: Array<number>, arr: typedndarray<T> ) => U;
 
 /**
 * Callback invoked for each ndarray element.
@@ -65,10 +65,10 @@ type Ternary<T, U, V> = ( this: V, value: T, indices: Array<number>, arr: typedn
 * @param arr - input array
 * @returns output value
 */
-type Callback<T, U, V> = Nullary<U, V> | Unary<T, U, V> | Binary<T, U, V> | Ternary<T, U, V>;
+type Callback<T, U, ThisArg> = Nullary<U, ThisArg> | Unary<T, U, ThisArg> | Binary<T, U, ThisArg> | Ternary<T, U, ThisArg>;
 
 /**
-* Applies a callback function to the elements in an input ndarray and assigns results to the elements in an output ndarray.
+* Applies a callback function to elements in an input ndarray and assigns results to elements in an output ndarray.
 *
 * @param arrays - array-like object containing one input ndarray and one output ndarray
 * @param fcn - callback function
@@ -103,7 +103,7 @@ type Callback<T, U, V> = Nullary<U, V> | Unary<T, U, V> | Binary<T, U, V> | Tern
 * var x = ndarray( 'float64', xbuf, shape, sx, ox, 'row-major' );
 * var y = ndarray( 'float64', ybuf, shape, sy, oy, 'row-major' );
 *
-* // Apply the map function:
+* // Apply function:
 * map( [ x, y ], scale );
 *
 * console.log( y.data );

base/map/lib/0d.js

@@ -84,7 +84,7 @@
 *     'order': 'row-major'
 * }
 *
-* // Apply the map function:
+* // Apply function:
 * map0d( x, y, scale, {} );
 *
 * console.log( y.data );

base/map/lib/0d_accessors.js

@@ -100,7 +100,7 @@
 *     'accessors': [ getter, setter ]
 * };
 *
-* // Apply the map function:
+* // Apply function:
 * map0d( x, y, scale, {} );
 *
 * var v = y.data.get( 0 );

base/map/lib/10d.js

@@ -94,7 +94,7 @@ var take = require( '@stdlib/array/base/take-indexed' );
 *     'order': 'row-major'
 * };
 *
-* // Apply the map function:
+* // Apply function:
 * map10d( x, y, true, scale, {} );
 *
 * console.log( y.data );

base/map/lib/10d_accessors.js

@@ -110,7 +110,7 @@ var take = require( '@stdlib/array/base/take-indexed' );
 *     'accessors': [ getter, setter ]
 * };
 *
-* // Apply the map function:
+* // Apply function:
 * map10d( x, y, true, scale, {} );
 *
 * var v = y.data.get( 0 );

base/map/lib/10d_blocked.js

@@ -94,7 +94,7 @@ var reverse = require( '@stdlib/array/base/reverse' );
 *     'order': 'row-major'
 * };
 *
-* // Apply the map function:
+* // Apply function:
 * blockedmap10d( x, y, scale, {} );
 *
 * console.log( y.data );

base/map/lib/10d_blocked_accessors.js

@@ -110,7 +110,7 @@ var reverse = require( '@stdlib/array/base/reverse' );
 *     'accessors': [ getter, setter ]
 * };
 *
-* // Apply the map function:
+* // Apply function:
 * blockedmap10d( x, y, scale, {} );
 *
 * var v = y.data.get( 0 );

base/map/lib/1d.js

@@ -84,7 +84,7 @@
 *     'order': 'row-major'
 * };
 *
-* // Apply the map function:
+* // Apply function:
 * map1d( x, y, scale, {} );
 *
 * console.log( y.data );

base/map/lib/1d_accessors.js

@@ -100,7 +100,7 @@
 *     'accessors': [ getter, setter ]
 * };
 *
-* // Apply the map function:
+* // Apply function:
 * map1d( x, y, scale, {} );
 *
 * var v = y.data.get( 0 );

base/map/lib/2d.js

@@ -92,7 +92,7 @@ var take = require( '@stdlib/array/base/take-indexed' );
 *     'order': 'row-major'
 * };
 *
-* // Apply the map function:
+* // Apply function:
 * map2d( x, y, true, scale, {} );
 *
 * console.log( y.data );

base/map/lib/2d_accessors.js

@@ -108,7 +108,7 @@ var take = require( '@stdlib/array/base/take-indexed' );
 *     'accessors': [ getter, setter ]
 * };
 *
-* // Apply the map function:
+* // Apply function:
 * map2d( x, y, true, scale, {} );
 *
 * var v = y.data.get( 0 );

base/map/lib/2d_blocked.js

@@ -92,7 +92,7 @@ var reverse = require( '@stdlib/array/base/reverse' );
 *     'order': 'row-major'
 * };
 *
-* // Apply the map function:
+* // Apply function:
 * blockedmap2d( x, y, scale, {} );
 *
 * console.log( y.data );

base/map/lib/2d_blocked_accessors.js

@@ -108,7 +108,7 @@ var reverse = require( '@stdlib/array/base/reverse' );
 *     'accessors': [ getter, setter ]
 * };
 *
-* // Apply the map function:
+* // Apply function:
 * blockedmap2d( x, y, scale, {} );
 *
 * var v = y.data.get( 0 );

base/map/lib/3d.js

@@ -92,7 +92,7 @@ var take = require( '@stdlib/array/base/take-indexed' );
 *     'order': 'row-major'
 * };
 *
-* // Apply the map function:
+* // Apply function:
 * map3d( x, y, true, scale, {} );
 *
 * console.log( y.data );

base/map/lib/3d_accessors.js

@@ -108,7 +108,7 @@ var take = require( '@stdlib/array/base/take-indexed' );
 *     'accessors': [ getter, setter ]
 * };
 *
-* // Apply the map function:
+* // Apply function:
 * map3d( x, y, true, scale, {} );
 *
 * var v = y.data.get( 0 );

base/map/lib/3d_blocked.js

@@ -94,7 +94,7 @@ var reverse = require( '@stdlib/array/base/reverse' );
 *     'order': 'row-major'
 * };
 *
-* // Apply the map function:
+* // Apply function:
 * blockedmap3d( x, y, scale, {} );
 *
 * console.log( y.data );

base/map/lib/3d_blocked_accessors.js

@@ -110,7 +110,7 @@ var reverse = require( '@stdlib/array/base/reverse' );
 *     'accessors': [ getter, setter ]
 * };
 *
-* // Apply the map function:
+* // Apply function:
 * blockedmap3d( x, y, scale, {} );
 *
 * var v = y.data.get( 0 );

base/map/lib/4d.js

@@ -92,7 +92,7 @@ var take = require( '@stdlib/array/base/take-indexed' );
 *     'order': 'row-major'
 * };
 *
-* // Apply the map function:
+* // Apply function:
 * map4d( x, y, true, scale, {} );
 *
 * console.log( y.data );

base/map/lib/4d_accessors.js

@@ -108,7 +108,7 @@ var take = require( '@stdlib/array/base/take-indexed' );
 *     'accessors': [ getter, setter ]
 * };
 *
-* // Apply the map function:
+* // Apply function:
 * map4d( x, y, true, scale, {} );
 *
 * var v = y.data.get( 0 );

base/map/lib/4d_blocked.js

@@ -94,7 +94,7 @@ var reverse = require( '@stdlib/array/base/reverse' );
 *     'order': 'row-major'
 * };
 *
-* // Apply the map function:
+* // Apply function:
 * blockedmap4d( x, y, scale, {} );
 *
 * console.log( y.data );

base/map/lib/4d_blocked_accessors.js

@@ -110,7 +110,7 @@ var reverse = require( '@stdlib/array/base/reverse' );
 *     'accessors': [ getter, setter ]
 * };
 *
-* // Apply the map function:
+* // Apply function:
 * blockedmap4d( x, y, scale, {} );
 *
 * var v = y.data.get( 0 );

base/map/lib/5d.js

@@ -92,7 +92,7 @@ var take = require( '@stdlib/array/base/take-indexed' );
 *     'order': 'row-major'
 * };
 *
-* // Apply the map function:
+* // Apply function:
 * map5d( x, y, true, scale, {} );
 *
 * console.log( y.data );

base/map/lib/5d_accessors.js

@@ -108,7 +108,7 @@ var take = require( '@stdlib/array/base/take-indexed' );
 *     'accessors': [ getter, setter ]
 * };
 *
-* // Apply the map function:
+* // Apply function:
 * map5d( x, y, true, scale, {} );
 *
 * var v = y.data.get( 0 );

base/map/lib/5d_blocked.js

@@ -94,7 +94,7 @@ var reverse = require( '@stdlib/array/base/reverse' );
 *     'order': 'row-major'
 * };
 *
-* // Apply the map function:
+* // Apply function:
 * blockedmap5d( x, y, scale, {} );
 *
 * console.log( y.data );

base/map/lib/5d_blocked_accessors.js

@@ -110,7 +110,7 @@ var reverse = require( '@stdlib/array/base/reverse' );
 *     'accessors': [ getter, setter ]
 * };
 *
-* // Apply the map function:
+* // Apply function:
 * blockedmap5d( x, y, scale, {} );
 *
 * var v = y.data.get( 0 );

base/map/lib/6d.js

@@ -94,7 +94,7 @@ var take = require( '@stdlib/array/base/take-indexed' );
 *     'order': 'row-major'
 * };
 *
-* // Apply the map function:
+* // Apply function:
 * map6d( x, y, true, scale, {} );
 *
 * console.log( y.data );

base/map/lib/6d_accessors.js

@@ -110,7 +110,7 @@ var take = require( '@stdlib/array/base/take-indexed' );
 *     'accessors': [ getter, setter ]
 * };
 *
-* // Apply the map function:
+* // Apply function:
 * map6d( x, y, true, scale, {} );
 *
 * var v = y.data.get( 0 );

base/map/lib/6d_blocked.js

@@ -94,7 +94,7 @@ var reverse = require( '@stdlib/array/base/reverse' );
 *     'order': 'row-major'
 * };
 *
-* // Apply the map function:
+* // Apply function:
 * blockedmap6d( x, y, scale, {} );
 *
 * console.log( y.data );

base/map/lib/6d_blocked_accessors.js

@@ -110,7 +110,7 @@ var reverse = require( '@stdlib/array/base/reverse' );
 *     'accessors': [ getter, setter ]
 * };
 *
-* // Apply the map function:
+* // Apply function:
 * blockedmap6d( x, y, scale, {} );
 *
 * var v = y.data.get( 0 );

base/map/lib/7d.js

@@ -94,7 +94,7 @@ var take = require( '@stdlib/array/base/take-indexed' );
 *     'order': 'row-major'
 * };
 *
-* // Apply the map function:
+* // Apply function:
 * map7d( x, y, true, scale, {} );
 *
 * console.log( y.data );

base/map/lib/7d_accessors.js

@@ -110,7 +110,7 @@ var take = require( '@stdlib/array/base/take-indexed' );
 *     'accessors': [ getter, setter ]
 * };
 *
-* // Apply the map function:
+* // Apply function:
 * map7d( x, y, true, scale, {} );
 *
 * var v = y.data.get( 0 );

base/map/lib/7d_blocked.js

@@ -94,7 +94,7 @@ var reverse = require( '@stdlib/array/base/reverse' );
 *     'order': 'row-major'
 * };
 *
-* // Apply the map function:
+* // Apply function:
 * blockedmap7d( x, y, scale, {} );
 *
 * console.log( y.data );

base/map/lib/7d_blocked_accessors.js

@@ -110,7 +110,7 @@ var reverse = require( '@stdlib/array/base/reverse' );
 *     'accessors': [ getter, setter ]
 * };
 *
-* // Apply the map function:
+* // Apply function:
 * blockedmap7d( x, y, scale, {} );
 *
 * var v = y.data.get( 0 );

base/map/lib/8d.js

@@ -94,7 +94,7 @@ var take = require( '@stdlib/array/base/take-indexed' );
 *     'order': 'row-major'
 * };
 *
-* // Apply the map function:
+* // Apply function:
 * map8d( x, y, true, scale, {} );
 *
 * console.log( y.data );

base/map/lib/8d_accessors.js

@@ -110,7 +110,7 @@ var take = require( '@stdlib/array/base/take-indexed' );
 *     'accessors': [ getter, setter ]
 * };
 *
-* // Apply the map function:
+* // Apply function:
 * map8d( x, y, true, scale, {} );
 *
 * var v = y.data.get( 0 );

base/map/lib/8d_blocked.js

@@ -94,7 +94,7 @@ var reverse = require( '@stdlib/array/base/reverse' );
 *     'order': 'row-major'
 * };
 *
-* // Apply the map function:
+* // Apply function:
 * blockedmap8d( x, y, scale, {} );
 *
 * console.log( y.data );

base/map/lib/8d_blocked_accessors.js

@@ -110,7 +110,7 @@ var reverse = require( '@stdlib/array/base/reverse' );
 *     'accessors': [ getter, setter ]
 * };
 *
-* // Apply the map function:
+* // Apply function:
 * blockedmap8d( x, y, scale, {} );
 *
 * var v = y.data.get( 0 );