From abea7437ead66a64bb5a10f0f244e8e14c9aa55a Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 2 Aug 2023 16:30:53 +0000 Subject: [PATCH] Auto-generated commit --- copy/lib/deep_copy.js | 1 - do-until-each-right/lib/main.js | 1 - do-until-each/lib/main.js | 1 - do-while-each-right/lib/main.js | 1 - do-while-each/lib/main.js | 1 - for-each-right/lib/main.js | 1 - for-in/lib/main.js | 1 - for-own/lib/main.js | 1 - group-by/lib/return_indices.js | 1 - group-by/lib/return_pairs.js | 1 - group-by/lib/return_values.js | 1 - group-in/lib/return_pairs.js | 1 - group-in/lib/return_values.js | 1 - group-own/lib/return_pairs.js | 1 - group-own/lib/return_values.js | 1 - group/lib/return_indices.js | 1 - group/lib/return_pairs.js | 1 - group/lib/return_values.js | 1 - inherit/lib/main.js | 1 - inmap-right/lib/main.js | 1 - inmap/lib/main.js | 1 - map-keys/lib/main.js | 1 - map-values/lib/main.js | 1 - tabulate-by/lib/main.js | 1 - timeit/lib/async.js | 1 - timeit/lib/sync.js | 1 - until-each-right/lib/main.js | 1 - while-each-right/lib/main.js | 1 - 28 files changed, 28 deletions(-) diff --git a/copy/lib/deep_copy.js b/copy/lib/deep_copy.js index 53e0891c..8674e492 100644 --- a/copy/lib/deep_copy.js +++ b/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 diff --git a/do-until-each-right/lib/main.js b/do-until-each-right/lib/main.js index 598ef578..47a43f8a 100644 --- a/do-until-each-right/lib/main.js +++ b/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 diff --git a/do-until-each/lib/main.js b/do-until-each/lib/main.js index b6f5c966..f30bbfe1 100644 --- a/do-until-each/lib/main.js +++ b/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 diff --git a/do-while-each-right/lib/main.js b/do-while-each-right/lib/main.js index 126e0847..6107f9be 100644 --- a/do-while-each-right/lib/main.js +++ b/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 diff --git a/do-while-each/lib/main.js b/do-while-each/lib/main.js index e91650a5..d7a78c2e 100644 --- a/do-while-each/lib/main.js +++ b/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 diff --git a/for-each-right/lib/main.js b/for-each-right/lib/main.js index be6a702c..1fd2b085 100644 --- a/for-each-right/lib/main.js +++ b/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 diff --git a/for-in/lib/main.js b/for-in/lib/main.js index 1e305290..ce45d368 100644 --- a/for-in/lib/main.js +++ b/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 diff --git a/for-own/lib/main.js b/for-own/lib/main.js index 3e871697..00bc80c8 100644 --- a/for-own/lib/main.js +++ b/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 diff --git a/group-by/lib/return_indices.js b/group-by/lib/return_indices.js index 1ad2d69a..11f8e909 100644 --- a/group-by/lib/return_indices.js +++ b/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 diff --git a/group-by/lib/return_pairs.js b/group-by/lib/return_pairs.js index 41d1f626..9f99615d 100644 --- a/group-by/lib/return_pairs.js +++ b/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 diff --git a/group-by/lib/return_values.js b/group-by/lib/return_values.js index f4079121..24438d48 100644 --- a/group-by/lib/return_values.js +++ b/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 diff --git a/group-in/lib/return_pairs.js b/group-in/lib/return_pairs.js index 7aa7a972..5b9aacaa 100644 --- a/group-in/lib/return_pairs.js +++ b/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 diff --git a/group-in/lib/return_values.js b/group-in/lib/return_values.js index 00158a6f..052d2849 100644 --- a/group-in/lib/return_values.js +++ b/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 diff --git a/group-own/lib/return_pairs.js b/group-own/lib/return_pairs.js index 4e78468a..dd201187 100644 --- a/group-own/lib/return_pairs.js +++ b/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 diff --git a/group-own/lib/return_values.js b/group-own/lib/return_values.js index 8131e9bd..5887aecb 100644 --- a/group-own/lib/return_values.js +++ b/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 diff --git a/group/lib/return_indices.js b/group/lib/return_indices.js index 305568f0..1a4b859d 100644 --- a/group/lib/return_indices.js +++ b/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 diff --git a/group/lib/return_pairs.js b/group/lib/return_pairs.js index 4f3cb643..30cfdcd7 100644 --- a/group/lib/return_pairs.js +++ b/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 diff --git a/group/lib/return_values.js b/group/lib/return_values.js index 5c44c550..56dd8888 100644 --- a/group/lib/return_values.js +++ b/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 diff --git a/inherit/lib/main.js b/inherit/lib/main.js index 9d0a7141..0d352f64 100644 --- a/inherit/lib/main.js +++ b/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 diff --git a/inmap-right/lib/main.js b/inmap-right/lib/main.js index 7b3a7ce7..bd0c5fff 100644 --- a/inmap-right/lib/main.js +++ b/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 diff --git a/inmap/lib/main.js b/inmap/lib/main.js index 48f53059..6fe185b1 100644 --- a/inmap/lib/main.js +++ b/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 diff --git a/map-keys/lib/main.js b/map-keys/lib/main.js index 51923945..5784b653 100644 --- a/map-keys/lib/main.js +++ b/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 diff --git a/map-values/lib/main.js b/map-values/lib/main.js index 54c0380a..3c1ed361 100644 --- a/map-values/lib/main.js +++ b/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 diff --git a/tabulate-by/lib/main.js b/tabulate-by/lib/main.js index 28d7306e..1e079f6b 100644 --- a/tabulate-by/lib/main.js +++ b/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 diff --git a/timeit/lib/async.js b/timeit/lib/async.js index b7211a46..20fddb88 100644 --- a/timeit/lib/async.js +++ b/timeit/lib/async.js @@ -84,7 +84,6 @@ var noop = 'next();'; * return 1; * ``` * -* * @private * @param {number} id - id * @param {string} code - code to time diff --git a/timeit/lib/sync.js b/timeit/lib/sync.js index 01ec9eda..9d0ed363 100644 --- a/timeit/lib/sync.js +++ b/timeit/lib/sync.js @@ -48,7 +48,6 @@ * return 1; * ``` * -* * @private * @param {number} id - id * @param {string} code - code to time diff --git a/until-each-right/lib/main.js b/until-each-right/lib/main.js index 9fe91781..ac1fa3e4 100644 --- a/until-each-right/lib/main.js +++ b/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 diff --git a/while-each-right/lib/main.js b/while-each-right/lib/main.js index 77bbc832..d57e5eeb 100644 --- a/while-each-right/lib/main.js +++ b/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