Skip to content

Commit

Permalink
Auto-generated commit
Browse files Browse the repository at this point in the history
  • Loading branch information
stdlib-bot committed Aug 2, 2023
1 parent 8447281 commit abea743
Show file tree
Hide file tree
Showing 28 changed files with 0 additions and 28 deletions.
1 change: 0 additions & 1 deletion copy/lib/deep_copy.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion do-until-each-right/lib/main.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion do-until-each/lib/main.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion do-while-each-right/lib/main.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion do-while-each/lib/main.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion for-each-right/lib/main.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion for-in/lib/main.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion for-own/lib/main.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion group-by/lib/return_indices.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion group-by/lib/return_pairs.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion group-by/lib/return_values.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion group-in/lib/return_pairs.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion group-in/lib/return_values.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion group-own/lib/return_pairs.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion group-own/lib/return_values.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion group/lib/return_indices.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion group/lib/return_pairs.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion group/lib/return_values.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion inherit/lib/main.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion inmap-right/lib/main.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion inmap/lib/main.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion map-keys/lib/main.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion map-values/lib/main.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion tabulate-by/lib/main.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion timeit/lib/async.js
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,6 @@ var noop = 'next();';
* return 1;
* ```
*
*
* @private
* @param {number} id - id
* @param {string} code - code to time
Expand Down
1 change: 0 additions & 1 deletion timeit/lib/sync.js
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,6 @@
* return 1;
* ```
*
*
* @private
* @param {number} id - id
* @param {string} code - code to time
Expand Down
1 change: 0 additions & 1 deletion until-each-right/lib/main.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion while-each-right/lib/main.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit abea743

Please sign in to comment.