Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -37,6 +37,7 @@ A total of 2 issues were closed in this release:
 
 <details>
 
+-   [`abb0dc3`](https://github.com/stdlib-js/stdlib/commit/abb0dc38783210623e67f19a5bb95b3998f75ff7) - **docs:** update examples and descriptions _(by Athan Reines)_
 -   [`95d0bbc`](https://github.com/stdlib-js/stdlib/commit/95d0bbc4b76c57dba4b4edd343dcd046490d4a51) - **bench:** test for primitive value _(by Athan Reines)_
 -   [`e3a2173`](https://github.com/stdlib-js/stdlib/commit/e3a2173a24bd8634f333cace626fc2d71740ebd3) - **feat:** add `every` method to `array/fixed-endian-factory` [(#3200)](https://github.com/stdlib-js/stdlib/pull/3200) _(by Aayush Khanna, Athan Reines)_
 -   [`b34732c`](https://github.com/stdlib-js/stdlib/commit/b34732cf655db60fbc798e12952f88c3edb07eaf) - **feat:** add `at` method to `array/fixed-endian-factory` [(#3184)](https://github.com/stdlib-js/stdlib/pull/3184) _(by Aayush Khanna, Athan Reines)_

README.md

@@ -349,6 +349,7 @@ Returns an array element located at integer position (index) `i`, with support f
 var Float64ArrayFE = fixedEndianFactory( 'float64' );
 
 var arr = new Float64ArrayFE( 'little-endian', [ 1.0, 2.0, 3.0 ] );
+// returns <Float64ArrayFE>
 
 var out = arr.at( 0 );
 // returns 1.0
@@ -363,6 +364,7 @@ If provided an out-of-bounds index, the method returns `undefined`.
 var Float64ArrayFE = fixedEndianFactory( 'float64' );
 
 var arr = new Float64ArrayFE( 'little-endian', [ 1.0, 2.0, 3.0 ] );
+// returns <Float64ArrayFE>
 
 var v = arr.at( 100 );
 // returns undefined
@@ -385,12 +387,13 @@ function isNegative( v ) {
 var Float64ArrayFE = fixedEndianFactory( 'float64' );
 
 var arr = new Float64ArrayFE( 'little-endian', [ -1.0, -2.0, -3.0, -4.0 ] );
+// returns <Float64ArrayFE>
 
 var bool = arr.every( isNegative );
 // returns true
 ```
 
-The invoked function is provided three arguments:
+The `predicate` function is provided three arguments:
 
 -   **value**: current array element.
 -   **index**: current array element index.
@@ -407,6 +410,7 @@ function isPositive( v, i ) {
 var Float64ArrayFE = fixedEndianFactory( 'float64' );
 
 var arr = new Float64ArrayFE( 'little-endian', [ 1.0, 2.0, -3.0 ] );
+// returns <Float64ArrayFE>
 
 var context = {
     'count': 0
@@ -433,6 +437,7 @@ function log( v, i ) {
 var Float64ArrayFE = fixedEndianFactory( 'float64' );
 
 var arr = new Float64ArrayFE( 'little-endian', 3 );
+// returns <Float64ArrayFE>
 
 arr.set( 1.5, 0 );
 arr.set( 2.5, 1 );
@@ -463,6 +468,7 @@ function fcn( v, i ) {
 var Float64ArrayFE = fixedEndianFactory( 'float64' );
 
 var arr = new Float64ArrayFE( 'little-endian', 3 );
+// returns <Float64ArrayFE>
 
 var context = {
     'count': 0
@@ -488,6 +494,7 @@ Returns an array element located at a nonnegative integer position (index) `i`.
 var Float64ArrayFE = fixedEndianFactory( 'float64' );
 
 var arr = new Float64ArrayFE( 'little-endian', 10 );
+// returns <Float64ArrayFE>
 
 // Set the first element:
 arr.set( 1.0, 0 );
@@ -503,6 +510,7 @@ If provided an out-of-bounds index, the method returns `undefined`.
 var Float64ArrayFE = fixedEndianFactory( 'float64' );
 
 var arr = new Float64ArrayFE( 'little-endian', 10 );
+// returns <Float64ArrayFE>
 
 var v = arr.get( 100 );
 // returns undefined
@@ -570,6 +578,7 @@ Serializes an array as a string.
 var Float64ArrayFE = fixedEndianFactory( 'float64' );
 
 var arr = new Float64ArrayFE( 'little-endian', [ 1.0, 2.0, 3.0 ] );
+// returns <Float64ArrayFE>
 
 var str = arr.toString();
 // returns '1,2,3'

dist/index.js.map

@@ -545,7 +545,7 @@ function factory( dtype ) { // eslint-disable-line max-lines-per-function, stdli
 	* @memberof TypedArray.prototype
 	* @type {Function}
 	* @param {Function} predicate - predicate function
-	* @param {*} [thisArg] - function invocation context
+	* @param {*} [thisArg] - predicate function execution context
 	* @throws {TypeError} `this` must be a typed array instance
 	* @throws {TypeError} first argument must be a function
 	* @returns {boolean} boolean indicating whether all elements pass a test