Auto-generated commit

copy/lib/deep_copy.js

@@ -46,7 +46,6 @@ var typedArrays = require( './typed_arrays.js' );
 * - This should **only** be used for simple cases. Any instances with privileged access to variables (e.g., within closures) cannot be cloned. This approach should be considered **fragile**.
 * - The function is greedy, disregarding the notion of a `level`. Instead, the function deep copies all properties, as we assume the concept of `level` applies only to the class instance reference but not to its internal state. This prevents, in theory, two instances from sharing state.
 *
-*
 * @private
 * @param {Object} val - class instance
 * @returns {Object} new instance

do-until-each-right/lib/main.js

@@ -36,7 +36,6 @@ var format = require( '@stdlib/string/format' );
 * - The condition is evaluated **after** executing the function to invoke; thus, the provided function **always** executes at least once.
 * - If provided an empty collection, the function invokes the provided function with the collection index set to `undefined`.
 *
-*
 * @param {Collection} collection - input collection
 * @param {Function} fcn - function to invoke
 * @param {Function} predicate - function which indicates whether to stop iterating over a collection

do-until-each/lib/main.js

@@ -35,7 +35,6 @@ var format = require( '@stdlib/string/format' );
 * - The condition is evaluated **after** executing the function to invoke; thus, the provided function **always** executes at least once.
 * - If provided an empty collection, the function invokes the provided function with the collection index set to `undefined`.
 *
-*
 * @param {Collection} collection - input collection
 * @param {Function} fcn - function to invoke
 * @param {Function} predicate - function which indicates whether to stop iterating over a collection

do-while-each-right/lib/main.js

@@ -36,7 +36,6 @@ var format = require( '@stdlib/string/format' );
 * - The condition is evaluated **after** executing the function to invoke; thus, the provided function **always** executes at least once.
 * - If provided an empty collection, the function invokes the provided function with the collection index set to `undefined`.
 *
-*
 * @param {Collection} collection - input collection
 * @param {Function} fcn - function to invoke
 * @param {Function} predicate - function which indicates whether to continue iterating over a collection

do-while-each/lib/main.js

@@ -35,7 +35,6 @@ var format = require( '@stdlib/string/format' );
 * - The condition is evaluated **after** executing the function to invoke; thus, the provided function **always** executes at least once.
 * - If provided an empty collection, the function invokes the provided function with the collection index set to `undefined`.
 *
-*
 * @param {Collection} collection - input collection
 * @param {Function} fcn - function to invoke
 * @param {Function} predicate - function which indicates whether to continue iterating over a collection

for-each-right/lib/main.js

@@ -34,7 +34,6 @@ var format = require( '@stdlib/string/format' );
 *
 * - For dynamic array resizing, the only behavior made intentionally consistent with `forEach` (iterating from left to right) is when elements are pushed onto the beginning (end) of an array. In other words, for `forEach()`, `[].push()` behavior is consistent with `forEachRight()` `[].unshift()` behavior.
 *
-*
 * @param {Collection} collection - input collection
 * @param {Function} fcn - function to invoke
 * @param {*} [thisArg] - execution context

for-in/lib/main.js

@@ -33,7 +33,6 @@ var format = require( '@stdlib/string/format' );
 *
 * - Iteration order is **not** guaranteed.
 *
-*
 * @param {Object} obj - input object
 * @param {Function} fcn - function to invoke
 * @param {*} [thisArg] - execution context

for-own/lib/main.js

@@ -34,7 +34,6 @@ var format = require( '@stdlib/string/format' );
 *
 * - Iteration order is **not** guaranteed.
 *
-*
 * @param {Object} obj - input object
 * @param {Function} fcn - function to invoke
 * @param {*} [thisArg] - execution context

group-by/lib/return_indices.js

@@ -32,7 +32,6 @@ var hasOwnProp = require( '@stdlib/assert/has-own-property' );
 *
 * - Checking for an "own" property is necessary to guard against the edge case where an indicator function returns a group identifier which matches a method or property on the `Object` prototype.
 *
-*
 * @private
 * @param {Collection} collection - collection to group
 * @param {Options} opts - function options

group-by/lib/return_pairs.js

@@ -33,7 +33,6 @@ var hasOwnProp = require( '@stdlib/assert/has-own-property' );
 * - We need to cache the collection value to prevent the edge case where, during the invocation of the indicator function, the element at index `i` is swapped for some other value. For some, that might be a feature; here, we take the stance that one should be less clever.
 * - Checking for an "own" property is necessary to guard against the edge case where an indicator function returns a group identifier which matches a method or property on the `Object` prototype.
 *
-*
 * @private
 * @param {Collection} collection - collection to group
 * @param {Options} opts - function options

group-by/lib/return_values.js

@@ -33,7 +33,6 @@ var hasOwnProp = require( '@stdlib/assert/has-own-property' );
 * - We need to cache the collection value to prevent the edge case where, during the invocation of the indicator function, the element at index `i` is swapped for some other value. For some, that might be a feature; here, we take the stance that one should be less clever.
 * - Checking for an "own" property is necessary to guard against the edge case where an indicator function returns a group identifier which matches a method or property on the `Object` prototype.
 *
-*
 * @private
 * @param {Collection} collection - collection to group
 * @param {Options} opts - function options

group-in/lib/return_pairs.js

@@ -32,7 +32,6 @@ var hasOwnProp = require( '@stdlib/assert/has-own-property' );
 *
 * - We need to cache the object value to prevent the edge case where, during the invocation of the indicator function, the value at key `k` is swapped for some other value. For some, that might be a feature; here, we take the stance that one should be less clever.
 *
-*
 * @private
 * @param {(Object|Array|TypedArray)} obj - input object
 * @param {Options} opts - function options

group-in/lib/return_values.js

@@ -32,7 +32,6 @@ var hasOwnProp = require( '@stdlib/assert/has-own-property' );
 *
 * - We need to cache the object value to prevent the edge case where, during the invocation of the indicator function, the value at key `k` is swapped for some other value. For some, that might be a feature; here, we take the stance that one should be less clever.
 *
-*
 * @private
 * @param {(Object|Array|TypedArray)} obj - input object
 * @param {Options} opts - function options

group-own/lib/return_pairs.js

@@ -32,7 +32,6 @@ var hasOwnProp = require( '@stdlib/assert/has-own-property' );
 *
 * - We need to cache the object value to prevent the edge case where, during the invocation of the indicator function, the value at key `k` is swapped for some other value. For some, that might be a feature; here, we take the stance that one should be less clever.
 *
-*
 * @private
 * @param {(Object|Array|TypedArray)} obj - input object
 * @param {Options} opts - function options

group-own/lib/return_values.js

@@ -32,7 +32,6 @@ var hasOwnProp = require( '@stdlib/assert/has-own-property' );
 *
 * - We need to cache the object value to prevent the edge case where, during the invocation of the indicator function, the value at key `k` is swapped for some other value. For some, that might be a feature; here, we take the stance that one should be less clever.
 *
-*
 * @private
 * @param {(Object|Array|TypedArray)} obj - input object
 * @param {Options} opts - function options

group/lib/return_indices.js

@@ -32,7 +32,6 @@ var hasOwnProp = require( '@stdlib/assert/has-own-property' );
 *
 * - Checking for an "own" property is necessary to guard against the edge case where a group identifier which matches a method or property on the `Object` prototype.
 *
-*
 * @private
 * @param {Collection} collection - collection to group
 * @param {Collection} groups - collection defining which group an element in the input collection belongs to

group/lib/return_pairs.js

@@ -32,7 +32,6 @@ var hasOwnProp = require( '@stdlib/assert/has-own-property' );
 *
 * - Checking for an "own" property is necessary to guard against the edge case where a group identifier which matches a method or property on the `Object` prototype.
 *
-*
 * @private
 * @param {Collection} collection - collection to group
 * @param {Collection} groups - collection defining which group an element in the input collection belongs to

group/lib/return_values.js

@@ -32,7 +32,6 @@ var hasOwnProp = require( '@stdlib/assert/has-own-property' );
 *
 * - Checking for an "own" property is necessary to guard against the edge case where a group identifier which matches a method or property on the `Object` prototype.
 *
-*
 * @private
 * @param {Collection} collection - collection to group
 * @param {Collection} groups - collection defining which group an element in the input collection belongs to

inherit/lib/main.js

@@ -36,7 +36,6 @@ var createObject = require( './detect.js' );
 * - This implementation is not designed to work with ES2015/ES6 classes. For ES2015/ES6 classes, use `class` with `extends`.
 * - For reference, see [node#3455](https://github.com/nodejs/node/pull/3455), [node#4179](https://github.com/nodejs/node/issues/4179), [node#3452](https://github.com/nodejs/node/issues/3452), and [node commit](https://github.com/nodejs/node/commit/29da8cf8d7ab8f66b9091ab22664067d4468461e#diff-3deb3f32958bb937ae05c6f3e4abbdf5).
 *
-*
 * @param {(Object|Function)} ctor - constructor which will inherit
 * @param {(Object|Function)} superCtor - super (parent) constructor
 * @throws {TypeError} first argument must be either an object or a function which can inherit

inmap-right/lib/main.js

@@ -34,7 +34,6 @@ var format = require( '@stdlib/string/format' );
 *
 * - For dynamic array resizing, the only behavior made intentionally consistent with `inmap` (iterating from left to right) is when elements are pushed onto the beginning (end) of an array. In other words, for `inmap()`, `[].push()` behavior is consistent with `inmapRight()` `[].unshift()` behavior.
 *
-*
 * @param {Collection} collection - input collection
 * @param {Function} fcn - function to invoke
 * @param {*} [thisArg] - execution context

inmap/lib/main.js

@@ -34,7 +34,6 @@ var format = require( '@stdlib/string/format' );
 *
 * - The invoked function's return value is cached prior to updating a collection. Before updating the collection, a collection must be inspected to ensure that a collection has not been resized during invocation such that an index no longer has a corresponding element in the collection. Were a return value automatically used to update a collection, an input collection could be converted into a sparse data structure. While some might consider this a feature, here, we take stance that a user should be less clever.
 *
-*
 * @param {Collection} collection - input collection
 * @param {Function} fcn - function to invoke
 * @param {*} [thisArg] - execution context

map-keys/lib/main.js

@@ -35,7 +35,6 @@ var format = require( '@stdlib/string/format' );
 * - Iteration order is **not** guaranteed.
 * - We need to cache an object value to prevent the edge case where, during the invocation of the transform function, the value corresponding to a particular key is swapped for some other value. For some, that might be a feature; here, we take the stance that one should be less clever.
 *
-*
 * @param {Object} obj - source object
 * @param {Function} transform - transform function
 * @throws {TypeError} first argument must be an object

map-values/lib/main.js

@@ -35,7 +35,6 @@ var format = require( '@stdlib/string/format' );
 * - Iteration order is **not** guaranteed.
 * - The function only operates on own properties, not inherited properties.
 *
-*
 * @param {Object} obj - source object
 * @param {Function} transform - transform function
 * @throws {TypeError} first argument must be an object

tabulate-by/lib/main.js

@@ -40,7 +40,6 @@ var validate = require( './validate.js' );
 * - 1: value count
 * - 2: frequency percentage
 *
-*
 * @param {Collection} collection - input collection
 * @param {Options} [options] - function options
 * @param {*} [options.thisArg] - execution context

timeit/lib/async.js

@@ -84,7 +84,6 @@ var noop = 'next();';
 * return 1;
 * ```
 *
-*
 * @private
 * @param {number} id - id
 * @param {string} code - code to time

timeit/lib/sync.js

@@ -48,7 +48,6 @@
 * return 1;
 * ```
 *
-*
 * @private
 * @param {number} id - id
 * @param {string} code - code to time

until-each-right/lib/main.js

@@ -34,7 +34,6 @@ var format = require( '@stdlib/string/format' );
 *
 * - For dynamic array resizing, the only behavior made intentionally consistent with `untilEach` (iterating from left to right) is when elements are pushed onto the beginning (end) of an array. In other words, for `untilEach()`, `[].push()` behavior is consistent with `untilEachRight()` `[].unshift()` behavior.
 *
-*
 * @param {Collection} collection - input collection
 * @param {Function} predicate - function which indicates whether to stop iterating over a collection
 * @param {Function} fcn - function to invoke

while-each-right/lib/main.js

@@ -34,7 +34,6 @@ var format = require( '@stdlib/string/format' );
 *
 * - For dynamic array resizing, the only behavior made intentionally consistent with `whileEach` (iterating from left to right) is when elements are pushed onto the beginning (end) of an array. In other words, for `whileEach()`, `[].push()` behavior is consistent with `whileEachRight()` `[].unshift()` behavior.
 *
-*
 * @param {Collection} collection - input collection
 * @param {Function} predicate - function which indicates whether to continue iterating over a collection
 * @param {Function} fcn - function to invoke