From cadb6131d6ce50338d11757e88e8a910a0367983 Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Mon, 16 Sep 2024 22:09:48 -0400 Subject: [PATCH] chore: update argument documentation styling --- lib/node_modules/@stdlib/array/from-iterator/README.md | 4 ++-- .../@stdlib/fs/resolve-parent-path-by/README.md | 6 +++--- lib/node_modules/@stdlib/iter/filter-map/README.md | 4 ++-- lib/node_modules/@stdlib/iter/filter/README.md | 4 ++-- lib/node_modules/@stdlib/iter/map/README.md | 4 ++-- lib/node_modules/@stdlib/utils/any-by-right/README.md | 6 +++--- lib/node_modules/@stdlib/utils/any-by/README.md | 6 +++--- lib/node_modules/@stdlib/utils/any-in-by/README.md | 6 +++--- lib/node_modules/@stdlib/utils/any-own-by/README.md | 6 +++--- lib/node_modules/@stdlib/utils/async/compose/README.md | 4 ++-- .../@stdlib/utils/async/function-sequence/README.md | 4 ++-- lib/node_modules/@stdlib/utils/bifurcate-by/README.md | 8 ++++---- lib/node_modules/@stdlib/utils/bifurcate-in/README.md | 8 ++++---- lib/node_modules/@stdlib/utils/bifurcate-own/README.md | 8 ++++---- lib/node_modules/@stdlib/utils/bifurcate/README.md | 2 +- lib/node_modules/@stdlib/utils/count-by/README.md | 6 +++--- .../@stdlib/utils/do-until-each-right/README.md | 6 +++--- lib/node_modules/@stdlib/utils/do-until-each/README.md | 6 +++--- lib/node_modules/@stdlib/utils/do-until/README.md | 2 +- .../@stdlib/utils/do-while-each-right/README.md | 6 +++--- lib/node_modules/@stdlib/utils/do-while-each/README.md | 6 +++--- lib/node_modules/@stdlib/utils/do-while/README.md | 2 +- lib/node_modules/@stdlib/utils/every-by-right/README.md | 6 +++--- lib/node_modules/@stdlib/utils/every-by/README.md | 6 +++--- lib/node_modules/@stdlib/utils/every-own-by/README.md | 6 +++--- lib/node_modules/@stdlib/utils/for-each-right/README.md | 6 +++--- lib/node_modules/@stdlib/utils/for-each/README.md | 6 +++--- lib/node_modules/@stdlib/utils/for-in/README.md | 6 +++--- lib/node_modules/@stdlib/utils/for-own/README.md | 6 +++--- lib/node_modules/@stdlib/utils/group-by/README.md | 8 ++++---- lib/node_modules/@stdlib/utils/group-in/README.md | 8 ++++---- lib/node_modules/@stdlib/utils/group-own/README.md | 8 ++++---- lib/node_modules/@stdlib/utils/group/README.md | 2 +- lib/node_modules/@stdlib/utils/inmap-right/README.md | 6 +++--- lib/node_modules/@stdlib/utils/inmap/README.md | 6 +++--- lib/node_modules/@stdlib/utils/key-by-right/README.md | 4 ++-- lib/node_modules/@stdlib/utils/key-by/README.md | 4 ++-- lib/node_modules/@stdlib/utils/map-keys/README.md | 6 +++--- lib/node_modules/@stdlib/utils/map-values/README.md | 6 +++--- lib/node_modules/@stdlib/utils/none-by-right/README.md | 6 +++--- lib/node_modules/@stdlib/utils/none-by/README.md | 6 +++--- lib/node_modules/@stdlib/utils/none-in-by/README.md | 6 +++--- .../@stdlib/utils/object-inverse-by/README.md | 6 +++--- lib/node_modules/@stdlib/utils/some-by-right/README.md | 6 +++--- lib/node_modules/@stdlib/utils/some-by/README.md | 6 +++--- lib/node_modules/@stdlib/utils/some-in-by/README.md | 6 +++--- lib/node_modules/@stdlib/utils/some-own-by/README.md | 6 +++--- lib/node_modules/@stdlib/utils/try-then/README.md | 2 +- lib/node_modules/@stdlib/utils/until-each/README.md | 6 +++--- lib/node_modules/@stdlib/utils/until/README.md | 2 +- lib/node_modules/@stdlib/utils/while-each/README.md | 6 +++--- lib/node_modules/@stdlib/utils/while/README.md | 2 +- 52 files changed, 140 insertions(+), 140 deletions(-) diff --git a/lib/node_modules/@stdlib/array/from-iterator/README.md b/lib/node_modules/@stdlib/array/from-iterator/README.md index d7f23f2db381..fbf7df28cb2d 100644 --- a/lib/node_modules/@stdlib/array/from-iterator/README.md +++ b/lib/node_modules/@stdlib/array/from-iterator/README.md @@ -85,8 +85,8 @@ var arr = iterator2array( array2iterator( [ 1, 2, 3, 4 ] ), fcn ); The invoked function is provided two arguments: -- `value`: iterated value -- `index`: iterated value index +- **value**: iterated value. +- **index**: iterated value index. ```javascript var Float64Array = require( '@stdlib/array/float64' ); diff --git a/lib/node_modules/@stdlib/fs/resolve-parent-path-by/README.md b/lib/node_modules/@stdlib/fs/resolve-parent-path-by/README.md index d8fcbf5416e7..6430bcd181b1 100644 --- a/lib/node_modules/@stdlib/fs/resolve-parent-path-by/README.md +++ b/lib/node_modules/@stdlib/fs/resolve-parent-path-by/README.md @@ -81,8 +81,8 @@ function onPath( error, path ) { When invoked, the `predicate` function is provided two arguments: -- `path`: a resolved path. -- `next`: a callback which should be called once the `predicate` function has finished processing a resolved path. +- **path**: a resolved path. +- **next**: a callback which should be called once the `predicate` function has finished processing a resolved path. If a `predicate` function calls the `next` callback with a truthy second argument, the function stops processing any additional paths and returns the resolved path as the test result. @@ -105,7 +105,7 @@ The function accepts the same `options` as [`resolveParentPathBy()`](#resolve-pa When invoked, the `predicate` function is provided one argument: -- `path`: a resolved path. +- **path**: a resolved path. The function immediately returns upon encountering a truthy `predicate` function return value. diff --git a/lib/node_modules/@stdlib/iter/filter-map/README.md b/lib/node_modules/@stdlib/iter/filter-map/README.md index e2d8b05925fd..c73b4c5f6709 100644 --- a/lib/node_modules/@stdlib/iter/filter-map/README.md +++ b/lib/node_modules/@stdlib/iter/filter-map/README.md @@ -73,8 +73,8 @@ The returned [iterator][mdn-iterator-protocol] protocol-compliant object has the The callback function is provided two arguments: -- `value`: iterated value -- `index`: iteration index (zero-based) +- **value**: iterated value. +- **index**: iteration index (zero-based). ```javascript var array2iterator = require( '@stdlib/array/to-iterator' ); diff --git a/lib/node_modules/@stdlib/iter/filter/README.md b/lib/node_modules/@stdlib/iter/filter/README.md index d7396f156744..b07b723961f5 100644 --- a/lib/node_modules/@stdlib/iter/filter/README.md +++ b/lib/node_modules/@stdlib/iter/filter/README.md @@ -71,8 +71,8 @@ The returned [iterator][mdn-iterator-protocol] protocol-compliant object has the The `predicate` function is provided two arguments: -- `value`: iterated value -- `index`: iteration index (zero-based) +- **value**: iterated value. +- **index**: iteration index (zero-based). ```javascript var array2iterator = require( '@stdlib/array/to-iterator' ); diff --git a/lib/node_modules/@stdlib/iter/map/README.md b/lib/node_modules/@stdlib/iter/map/README.md index 24acc93f69e5..3b80c857fc98 100644 --- a/lib/node_modules/@stdlib/iter/map/README.md +++ b/lib/node_modules/@stdlib/iter/map/README.md @@ -73,8 +73,8 @@ The returned [iterator][mdn-iterator-protocol] protocol-compliant object has the The invoked `function` is provided two arguments: -- `value`: iterated value -- `index`: iteration index (zero-based) +- **value**: iterated value. +- **index**: iteration index (zero-based). ```javascript var array2iterator = require( '@stdlib/array/to-iterator' ); diff --git a/lib/node_modules/@stdlib/utils/any-by-right/README.md b/lib/node_modules/@stdlib/utils/any-by-right/README.md index cc6eb09008e4..79438586bf93 100644 --- a/lib/node_modules/@stdlib/utils/any-by-right/README.md +++ b/lib/node_modules/@stdlib/utils/any-by-right/README.md @@ -73,9 +73,9 @@ var bool = anyByRight( arr, isNegative ); The invoked `function` is provided three arguments: -- `value`: collection element -- `index`: collection index -- `collection`: input collection +- **value**: collection element. +- **index**: collection index. +- **collection**: input collection. To set the function execution context, provide a `thisArg`. diff --git a/lib/node_modules/@stdlib/utils/any-by/README.md b/lib/node_modules/@stdlib/utils/any-by/README.md index 826e86abcd37..65a3cd813367 100644 --- a/lib/node_modules/@stdlib/utils/any-by/README.md +++ b/lib/node_modules/@stdlib/utils/any-by/README.md @@ -73,9 +73,9 @@ var bool = anyBy( arr, isPositive ); The invoked `function` is provided three arguments: -- `value`: collection element -- `index`: collection index -- `collection`: input collection +- **value**: collection element. +- **index**: collection index. +- **collection**: input collection. To set the function execution context, provide a `thisArg`. diff --git a/lib/node_modules/@stdlib/utils/any-in-by/README.md b/lib/node_modules/@stdlib/utils/any-in-by/README.md index 61ae4e2da7df..7c08decc0326 100644 --- a/lib/node_modules/@stdlib/utils/any-in-by/README.md +++ b/lib/node_modules/@stdlib/utils/any-in-by/README.md @@ -81,9 +81,9 @@ var bool = anyInBy( obj, isPositive ); The invoked `function` is provided three arguments: -- `value`: property value -- `key`: property key -- `object`: input object +- **value**: property value. +- **key**: property key. +- **object**: input object. To set the function execution context, provide a `thisArg`. diff --git a/lib/node_modules/@stdlib/utils/any-own-by/README.md b/lib/node_modules/@stdlib/utils/any-own-by/README.md index 5fba1a895494..32785b274d7a 100644 --- a/lib/node_modules/@stdlib/utils/any-own-by/README.md +++ b/lib/node_modules/@stdlib/utils/any-own-by/README.md @@ -85,9 +85,9 @@ var bool = anyOwnBy( obj, isPositive ); The invoked `function` is provided three arguments: -- `value`: property value -- `key`: property key -- `obj`: input object +- **value**: property value. +- **key**: property key. +- **obj**: input object. To set the function execution context, provide a `thisArg`. diff --git a/lib/node_modules/@stdlib/utils/async/compose/README.md b/lib/node_modules/@stdlib/utils/async/compose/README.md index 644e667be639..63f40dddbd82 100644 --- a/lib/node_modules/@stdlib/utils/async/compose/README.md +++ b/lib/node_modules/@stdlib/utils/async/compose/README.md @@ -81,8 +81,8 @@ f( 6, done ); // ((2*x)+3)/5 The last argument provided to each composed function is a `next` callback which accepts two arguments: -- `error`: error argument -- `result`: function result +- **error**: error argument. +- **result**: function result. **Only** the rightmost function is explicitly permitted to accept multiple arguments. All other functions are evaluated as **binary** functions. diff --git a/lib/node_modules/@stdlib/utils/async/function-sequence/README.md b/lib/node_modules/@stdlib/utils/async/function-sequence/README.md index 0c3903303d0a..282288139978 100644 --- a/lib/node_modules/@stdlib/utils/async/function-sequence/README.md +++ b/lib/node_modules/@stdlib/utils/async/function-sequence/README.md @@ -81,8 +81,8 @@ f( 6, done ); // ((2*x)+3)/5 The last argument provided to each function is a `next` callback which accepts two arguments: -- `error`: error argument -- `result`: function result +- **error**: error argument. +- **result**: function result. **Only** the leftmost function is explicitly permitted to accept multiple arguments. All other functions are evaluated as **binary** functions. diff --git a/lib/node_modules/@stdlib/utils/bifurcate-by/README.md b/lib/node_modules/@stdlib/utils/bifurcate-by/README.md index 2d418e397a43..a7260da6347f 100644 --- a/lib/node_modules/@stdlib/utils/bifurcate-by/README.md +++ b/lib/node_modules/@stdlib/utils/bifurcate-by/README.md @@ -56,8 +56,8 @@ var out = bifurcateBy( arr, predicate ); A `predicate` function is provided two arguments: -- `value`: collection element -- `index`: collection index +- **value**: collection element. +- **index**: collection index. ```javascript function predicate( v, i ) { @@ -72,8 +72,8 @@ var out = bifurcateBy( arr, predicate ); The function accepts the following `options`: -- `returns`: specifies the output format. If the option equals `'values'`, the function outputs element values. If the option equals `'indices'`, the function outputs element indices. If the option equals `'*'`, the function outputs both element indices and values. Default: `'values'`. -- `thisArg`: execution context. +- **returns**: specifies the output format. If the option equals `'values'`, the function outputs element values. If the option equals `'indices'`, the function outputs element indices. If the option equals `'*'`, the function outputs both element indices and values. Default: `'values'`. +- **thisArg**: execution context. By default, the function returns element values. To return element indices, set the `returns` option to `'indices'`. diff --git a/lib/node_modules/@stdlib/utils/bifurcate-in/README.md b/lib/node_modules/@stdlib/utils/bifurcate-in/README.md index c6e30a7bb549..6b8ce9d97eed 100644 --- a/lib/node_modules/@stdlib/utils/bifurcate-in/README.md +++ b/lib/node_modules/@stdlib/utils/bifurcate-in/README.md @@ -67,8 +67,8 @@ var out = bifurcateIn( obj, predicate ); A `predicate` function is provided two arguments: -- `value`: object value -- `key`: object index +- **value**: object value. +- **key**: object index. ```javascript function predicate( v, k ) { @@ -93,8 +93,8 @@ var out = bifurcateIn( obj, predicate ); The function accepts the following `options`: -- `returns`: specifies the output format. If the option equals `'values'`, the function outputs values. If the option equals `'keys'`, the function outputs keys. If the option equals `'*'`, the function outputs both keys and values. Default: `'values'`. -- `thisArg`: execution context. +- **returns**: specifies the output format. If the option equals `'values'`, the function outputs values. If the option equals `'keys'`, the function outputs keys. If the option equals `'*'`, the function outputs both keys and values. Default: `'values'`. +- **thisArg**: execution context. By default, the function returns object values. To return object keys, set the `returns` option to `'keys'`. diff --git a/lib/node_modules/@stdlib/utils/bifurcate-own/README.md b/lib/node_modules/@stdlib/utils/bifurcate-own/README.md index 5da81cf255c3..3270604a5be2 100644 --- a/lib/node_modules/@stdlib/utils/bifurcate-own/README.md +++ b/lib/node_modules/@stdlib/utils/bifurcate-own/README.md @@ -61,8 +61,8 @@ var out = bifurcateOwn( obj, predicate ); A `predicate` function is provided two arguments: -- `value`: object value -- `key`: object index +- **value**: object value. +- **key**: object index. ```javascript function predicate( v, k ) { @@ -82,8 +82,8 @@ var out = bifurcateOwn( obj, predicate ); The function accepts the following `options`: -- `returns`: specifies the output format. If the option equals `'values'`, the function outputs values. If the option equals `'keys'`, the function outputs keys. If the option equals `'*'`, the function outputs both keys and values. Default: `'values'`. -- `thisArg`: execution context. +- **returns**: specifies the output format. If the option equals `'values'`, the function outputs values. If the option equals `'keys'`, the function outputs keys. If the option equals `'*'`, the function outputs both keys and values. Default: `'values'`. +- **thisArg**: execution context. By default, the function returns object values. To return object keys, set the `returns` option to `'keys'`. diff --git a/lib/node_modules/@stdlib/utils/bifurcate/README.md b/lib/node_modules/@stdlib/utils/bifurcate/README.md index 9effed1d963e..db3fff87f030 100644 --- a/lib/node_modules/@stdlib/utils/bifurcate/README.md +++ b/lib/node_modules/@stdlib/utils/bifurcate/README.md @@ -54,7 +54,7 @@ var out = bifurcate( arr, filter ); The function accepts the following `options`: -- `returns`: specifies the output format. If the option equals `'values'`, the function outputs element values. If the option equals `'indices'`, the function outputs element indices. If the option equals `'*'`, the function outputs both element indices and values. Default: `'values'`. +- **returns**: specifies the output format. If the option equals `'values'`, the function outputs element values. If the option equals `'indices'`, the function outputs element indices. If the option equals `'*'`, the function outputs both element indices and values. Default: `'values'`. By default, the function returns element values. To return element indices, set the `returns` option to `'indices'`. diff --git a/lib/node_modules/@stdlib/utils/count-by/README.md b/lib/node_modules/@stdlib/utils/count-by/README.md index bc70a8cebec2..48f4347122d0 100644 --- a/lib/node_modules/@stdlib/utils/count-by/README.md +++ b/lib/node_modules/@stdlib/utils/count-by/README.md @@ -56,8 +56,8 @@ var out = countBy( arr, indicator ); An `indicator` function is provided two arguments: -- `value`: collection element -- `index`: collection index +- **value**: collection element. +- **index**: collection index. ```javascript function indicator( v, i ) { @@ -72,7 +72,7 @@ var out = countBy( arr, indicator ); The function accepts the following `options`: -- `thisArg`: execution context. +- **thisArg**: execution context. To set the `indicator` execution context, provide a `thisArg`. diff --git a/lib/node_modules/@stdlib/utils/do-until-each-right/README.md b/lib/node_modules/@stdlib/utils/do-until-each-right/README.md index 77604d5d80f4..bbfbb8f50171 100644 --- a/lib/node_modules/@stdlib/utils/do-until-each-right/README.md +++ b/lib/node_modules/@stdlib/utils/do-until-each-right/README.md @@ -66,9 +66,9 @@ doUntilEachRight( arr, log, predicate ); Both the `predicate` function and the `function` to apply are provided three arguments: -- `value`: collection element -- `index`: collection index -- `collection`: input collection +- **value**: collection element. +- **index**: collection index. +- **collection**: input collection. If provided an empty `collection`, both `value` and `index` are `undefined`. diff --git a/lib/node_modules/@stdlib/utils/do-until-each/README.md b/lib/node_modules/@stdlib/utils/do-until-each/README.md index 29c51bb5efaa..157c94c5ed43 100644 --- a/lib/node_modules/@stdlib/utils/do-until-each/README.md +++ b/lib/node_modules/@stdlib/utils/do-until-each/README.md @@ -66,9 +66,9 @@ doUntilEach( arr, log, predicate ); Both the `predicate` function and the `function` to apply are provided three arguments: -- `value`: collection element -- `index`: collection index -- `collection`: input collection +- **value**: collection element. +- **index**: collection index. +- **collection**: input collection. If provided an empty `collection`, both `value` and `index` are `undefined`. diff --git a/lib/node_modules/@stdlib/utils/do-until/README.md b/lib/node_modules/@stdlib/utils/do-until/README.md index bcee01bef081..68296d600eb3 100644 --- a/lib/node_modules/@stdlib/utils/do-until/README.md +++ b/lib/node_modules/@stdlib/utils/do-until/README.md @@ -65,7 +65,7 @@ doUntil( beep, predicate ); Both the `predicate` function and the `function` to invoke are provided a single argument: -- `i`: iteration number (starting from zero) +- **i**: iteration number (starting from zero). To set the function execution context for the invoked function, provide a `thisArg`. diff --git a/lib/node_modules/@stdlib/utils/do-while-each-right/README.md b/lib/node_modules/@stdlib/utils/do-while-each-right/README.md index fc155f851a66..885484951783 100644 --- a/lib/node_modules/@stdlib/utils/do-while-each-right/README.md +++ b/lib/node_modules/@stdlib/utils/do-while-each-right/README.md @@ -66,9 +66,9 @@ doWhileEachRight( arr, log, predicate ); Both the `predicate` function and the `function` to apply are provided three arguments: -- `value`: collection element -- `index`: collection index -- `collection`: input collection +- **value**: collection element. +- **index**: collection index. +- **collection**: input collection. If provided an empty `collection`, both `value` and `index` are `undefined`. diff --git a/lib/node_modules/@stdlib/utils/do-while-each/README.md b/lib/node_modules/@stdlib/utils/do-while-each/README.md index 4df3acb72c8a..ec7658863ba5 100644 --- a/lib/node_modules/@stdlib/utils/do-while-each/README.md +++ b/lib/node_modules/@stdlib/utils/do-while-each/README.md @@ -66,9 +66,9 @@ doWhileEach( arr, log, predicate ); Both the `predicate` function and the `function` to apply are provided three arguments: -- `value`: collection element -- `index`: collection index -- `collection`: input collection +- **value**: collection element. +- **index**: collection index. +- **collection**: input collection. If provided an empty `collection`, both `value` and `index` are `undefined`. diff --git a/lib/node_modules/@stdlib/utils/do-while/README.md b/lib/node_modules/@stdlib/utils/do-while/README.md index 2f6d73307818..4905d5136ebf 100644 --- a/lib/node_modules/@stdlib/utils/do-while/README.md +++ b/lib/node_modules/@stdlib/utils/do-while/README.md @@ -65,7 +65,7 @@ doWhile( beep, predicate ); Both the `predicate` function and the `function` to invoke are provided a single argument: -- `i`: iteration number (starting from zero) +- **i**: iteration number (starting from zero). To set the function execution context for the invoked function, provide a `thisArg`. diff --git a/lib/node_modules/@stdlib/utils/every-by-right/README.md b/lib/node_modules/@stdlib/utils/every-by-right/README.md index ab1a5e02871d..f6e201fb70ad 100644 --- a/lib/node_modules/@stdlib/utils/every-by-right/README.md +++ b/lib/node_modules/@stdlib/utils/every-by-right/README.md @@ -70,9 +70,9 @@ var bool = everyByRight( arr, isPositive ); The invoked `function` is provided three arguments: -- `value`: collection element -- `index`: collection index -- `collection`: input collection +- **value**: collection element. +- **index**: collection index. +- **collection**: input collection. To set the function execution context, provide a `thisArg`. diff --git a/lib/node_modules/@stdlib/utils/every-by/README.md b/lib/node_modules/@stdlib/utils/every-by/README.md index 97ccaddb81d6..934c22ca3fc8 100644 --- a/lib/node_modules/@stdlib/utils/every-by/README.md +++ b/lib/node_modules/@stdlib/utils/every-by/README.md @@ -70,9 +70,9 @@ var bool = everyBy( arr, isPositive ); The invoked `function` is provided three arguments: -- `value`: collection element -- `index`: collection index -- `collection`: input collection +- **value**: collection element. +- **index**: collection index. +- **collection**: input collection. To set the function execution context, provide a `thisArg`. diff --git a/lib/node_modules/@stdlib/utils/every-own-by/README.md b/lib/node_modules/@stdlib/utils/every-own-by/README.md index fa3d924dc04a..a59f6754a060 100644 --- a/lib/node_modules/@stdlib/utils/every-own-by/README.md +++ b/lib/node_modules/@stdlib/utils/every-own-by/README.md @@ -80,9 +80,9 @@ var bool = everyOwnBy( obj, isPositive ); The invoked `function` is provided three arguments: -- `value`: property value -- `key`: property key -- `obj`: input object +- **value**: property value. +- **key**: property key. +- **obj**: input object. To set the function execution context, provide a `thisArg`. diff --git a/lib/node_modules/@stdlib/utils/for-each-right/README.md b/lib/node_modules/@stdlib/utils/for-each-right/README.md index f54a3913577b..db8e1eecb85f 100644 --- a/lib/node_modules/@stdlib/utils/for-each-right/README.md +++ b/lib/node_modules/@stdlib/utils/for-each-right/README.md @@ -62,9 +62,9 @@ forEachRight( arr, log ); The invoked `function` is provided three arguments: -- `value`: collection element -- `index`: collection index -- `collection`: input collection +- **value**: collection element. +- **index**: collection index. +- **collection**: input collection. Basic support for dynamic collections is provided. Note, however, that index incrementation is **not** guaranteed to be monotonically **decreasing**. diff --git a/lib/node_modules/@stdlib/utils/for-each/README.md b/lib/node_modules/@stdlib/utils/for-each/README.md index 46a05850d8a5..5d53a332eb8d 100644 --- a/lib/node_modules/@stdlib/utils/for-each/README.md +++ b/lib/node_modules/@stdlib/utils/for-each/README.md @@ -62,9 +62,9 @@ forEach( arr, log ); The invoked `function` is provided three arguments: -- `value`: collection element -- `index`: collection index -- `collection`: input collection +- **value**: collection element. +- **index**: collection index. +- **collection**: input collection. Basic support for dynamic collections is provided. Note, however, that index incrementation is monotonically increasing. diff --git a/lib/node_modules/@stdlib/utils/for-in/README.md b/lib/node_modules/@stdlib/utils/for-in/README.md index 8c1a0f1c6bfe..a3d4565e6fb8 100644 --- a/lib/node_modules/@stdlib/utils/for-in/README.md +++ b/lib/node_modules/@stdlib/utils/for-in/README.md @@ -71,9 +71,9 @@ forIn( obj, log ); The invoked `function` is provided three arguments: -- `value`: object property value -- `key`: object property -- `obj`: the input object +- **value**: object property value. +- **key**: object property. +- **obj**: the input object. To terminate iteration before visiting all properties, the provided function must explicitly return `false`. diff --git a/lib/node_modules/@stdlib/utils/for-own/README.md b/lib/node_modules/@stdlib/utils/for-own/README.md index 401b94da06f6..6b1a16a267a3 100644 --- a/lib/node_modules/@stdlib/utils/for-own/README.md +++ b/lib/node_modules/@stdlib/utils/for-own/README.md @@ -67,9 +67,9 @@ forOwn( obj, log ); The invoked `function` is provided three arguments: -- `value`: object property value -- `key`: object property -- `obj`: the input object +- **value**: object property value. +- **key**: object property. +- **obj**: the input object. To terminate iteration before visiting all properties, the provided function must explicitly return `false`. diff --git a/lib/node_modules/@stdlib/utils/group-by/README.md b/lib/node_modules/@stdlib/utils/group-by/README.md index f5cad0e43f64..c05d230968f3 100644 --- a/lib/node_modules/@stdlib/utils/group-by/README.md +++ b/lib/node_modules/@stdlib/utils/group-by/README.md @@ -56,8 +56,8 @@ var out = groupBy( arr, indicator ); An `indicator` function is provided two arguments: -- `value`: collection element -- `index`: collection index +- **value**: collection element. +- **index**: collection index. ```javascript function indicator( v, i ) { @@ -72,8 +72,8 @@ var out = groupBy( arr, indicator ); The function accepts the following `options`: -- `returns`: specifies the output format. If the option equals `'values'`, the function outputs element values. If the option equals `'indices'`, the function outputs element indices. If the option equals `'*'`, the function outputs both element indices and values. Default: `'values'`. -- `thisArg`: execution context. +- **returns**: specifies the output format. If the option equals `'values'`, the function outputs element values. If the option equals `'indices'`, the function outputs element indices. If the option equals `'*'`, the function outputs both element indices and values. Default: `'values'`. +- **thisArg**: execution context. By default, the function returns element values. To return element indices, set the `returns` option to `'indices'`. diff --git a/lib/node_modules/@stdlib/utils/group-in/README.md b/lib/node_modules/@stdlib/utils/group-in/README.md index d9f2d1567f17..b6cf5c45db94 100644 --- a/lib/node_modules/@stdlib/utils/group-in/README.md +++ b/lib/node_modules/@stdlib/utils/group-in/README.md @@ -67,8 +67,8 @@ var out = groupIn( obj, indicator ); An `indicator` function is provided two arguments: -- `value`: object value -- `key`: object index +- **value**: object value. +- **key**: object index. ```javascript function indicator( v, k ) { @@ -94,8 +94,8 @@ var out = groupIn( obj, indicator ); The function accepts the following `options`: -- `returns`: specifies the output format. If the option equals `'values'`, the function outputs values. If the option equals `'keys'`, the function outputs keys. If the option equals `'*'`, the function outputs both keys and values. Default: `'values'`. -- `thisArg`: execution context. +- **returns**: specifies the output format. If the option equals `'values'`, the function outputs values. If the option equals `'keys'`, the function outputs keys. If the option equals `'*'`, the function outputs both keys and values. Default: `'values'`. +- **thisArg**: execution context. By default, the function returns object values. To return object keys, set the `returns` option to `'keys'`. diff --git a/lib/node_modules/@stdlib/utils/group-own/README.md b/lib/node_modules/@stdlib/utils/group-own/README.md index cd106be622ec..b899fd162ad8 100644 --- a/lib/node_modules/@stdlib/utils/group-own/README.md +++ b/lib/node_modules/@stdlib/utils/group-own/README.md @@ -61,8 +61,8 @@ var out = groupOwn( obj, indicator ); An `indicator` function is provided two arguments: -- `value`: object value -- `key`: object index +- **value**: object value. +- **key**: object index. ```javascript function indicator( v, k ) { @@ -82,8 +82,8 @@ var out = groupOwn( obj, indicator ); The function accepts the following `options`: -- `returns`: specifies the output format. If the option equals `'values'`, the function outputs values. If the option equals `'keys'`, the function outputs keys. If the option equals `'*'`, the function outputs both keys and values. Default: `'values'`. -- `thisArg`: execution context. +- **returns**: specifies the output format. If the option equals `'values'`, the function outputs values. If the option equals `'keys'`, the function outputs keys. If the option equals `'*'`, the function outputs both keys and values. Default: `'values'`. +- **thisArg**: execution context. By default, the function returns object values. To return object keys, set the `returns` option to `'keys'`. diff --git a/lib/node_modules/@stdlib/utils/group/README.md b/lib/node_modules/@stdlib/utils/group/README.md index 007b4be1e2e4..e662c68818b1 100644 --- a/lib/node_modules/@stdlib/utils/group/README.md +++ b/lib/node_modules/@stdlib/utils/group/README.md @@ -54,7 +54,7 @@ var out = group( arr, groups ); The function accepts the following `options`: -- `returns`: specifies the output format. If the option equals `'values'`, the function outputs element values. If the option equals `'indices'`, the function outputs element indices. If the option equals `'*'`, the function outputs both element indices and values. Default: `'values'`. +- **returns**: specifies the output format. If the option equals `'values'`, the function outputs element values. If the option equals `'indices'`, the function outputs element indices. If the option equals `'*'`, the function outputs both element indices and values. Default: `'values'`. By default, the function returns element values. To return element indices, set the `returns` option to `'indices'`. diff --git a/lib/node_modules/@stdlib/utils/inmap-right/README.md b/lib/node_modules/@stdlib/utils/inmap-right/README.md index 0276626f735d..a9dbbe6c7224 100644 --- a/lib/node_modules/@stdlib/utils/inmap-right/README.md +++ b/lib/node_modules/@stdlib/utils/inmap-right/README.md @@ -60,9 +60,9 @@ var bool = ( out === arr ); The invoked `function` is provided three arguments: -- `value`: collection element -- `index`: collection index -- `collection`: input collection +- **value**: collection element. +- **index**: collection index. +- **collection**: input collection. Basic support for dynamic collections is provided. Note, however, that index incrementation is **not** guaranteed to be monotonically **decreasing**. diff --git a/lib/node_modules/@stdlib/utils/inmap/README.md b/lib/node_modules/@stdlib/utils/inmap/README.md index 2cf3945004fc..ae2c29f73a28 100644 --- a/lib/node_modules/@stdlib/utils/inmap/README.md +++ b/lib/node_modules/@stdlib/utils/inmap/README.md @@ -60,9 +60,9 @@ var bool = ( out === arr ); The invoked `function` is provided three arguments: -- `value`: collection element -- `index`: collection index -- `collection`: input collection +- **value**: collection element. +- **index**: collection index. +- **collection**: input collection. Basic support for dynamic collections is provided. Note, however, that index incrementation is monotonically increasing. diff --git a/lib/node_modules/@stdlib/utils/key-by-right/README.md b/lib/node_modules/@stdlib/utils/key-by-right/README.md index 0998436dc6a0..e10f3a21cfba 100644 --- a/lib/node_modules/@stdlib/utils/key-by-right/README.md +++ b/lib/node_modules/@stdlib/utils/key-by-right/README.md @@ -62,8 +62,8 @@ var out = keyByRight( arr, toKey ); The invoked `function` is provided two arguments: -- `value`: collection element -- `index`: collection index +- **value**: collection element. +- **index**: collection index. To set the function execution context, provide a `thisArg`. diff --git a/lib/node_modules/@stdlib/utils/key-by/README.md b/lib/node_modules/@stdlib/utils/key-by/README.md index 3c49f67179aa..615592a1ef74 100644 --- a/lib/node_modules/@stdlib/utils/key-by/README.md +++ b/lib/node_modules/@stdlib/utils/key-by/README.md @@ -62,8 +62,8 @@ var out = keyBy( arr, toKey ); The invoked `function` is provided two arguments: -- `value`: collection element -- `index`: collection index +- **value**: collection element. +- **index**: collection index. To set the function execution context, provide a `thisArg`. diff --git a/lib/node_modules/@stdlib/utils/map-keys/README.md b/lib/node_modules/@stdlib/utils/map-keys/README.md index b9e011c9267f..4a64872c8459 100644 --- a/lib/node_modules/@stdlib/utils/map-keys/README.md +++ b/lib/node_modules/@stdlib/utils/map-keys/README.md @@ -60,9 +60,9 @@ var obj2 = mapKeys( obj1, transform ); The `transform` function is provided three arguments: -- `key`: object key -- `value`: object value corresponding to `key` -- `obj`: the input object +- **key**: object key. +- **value**: object value corresponding to `key`. +- **obj**: the input object. diff --git a/lib/node_modules/@stdlib/utils/map-values/README.md b/lib/node_modules/@stdlib/utils/map-values/README.md index 5cabd708bdd1..d461a32a695f 100644 --- a/lib/node_modules/@stdlib/utils/map-values/README.md +++ b/lib/node_modules/@stdlib/utils/map-values/README.md @@ -60,9 +60,9 @@ var obj2 = mapValues( obj1, transform ); The `transform` function is provided three arguments: -- `value`: object value corresponding to `key` -- `key`: object key -- `obj`: the input object +- **value**: object value corresponding to `key`. +- **key**: object key. +- **obj**: the input object. diff --git a/lib/node_modules/@stdlib/utils/none-by-right/README.md b/lib/node_modules/@stdlib/utils/none-by-right/README.md index 8f217fb092b2..d2079f681fb4 100644 --- a/lib/node_modules/@stdlib/utils/none-by-right/README.md +++ b/lib/node_modules/@stdlib/utils/none-by-right/README.md @@ -70,9 +70,9 @@ var bool = noneByRight( arr, isPositive ); The invoked `function` is provided three arguments: -- `value`: collection element -- `index`: collection index -- `collection`: input collection +- **value**: collection element. +- **index**: collection index. +- **collection**: input collection. To set the function execution context, provide a `thisArg`. diff --git a/lib/node_modules/@stdlib/utils/none-by/README.md b/lib/node_modules/@stdlib/utils/none-by/README.md index d2b746bdbb1d..ffbc6f63a06f 100644 --- a/lib/node_modules/@stdlib/utils/none-by/README.md +++ b/lib/node_modules/@stdlib/utils/none-by/README.md @@ -70,9 +70,9 @@ var bool = noneBy( arr, isPositive ); The invoked `function` is provided three arguments: -- `value`: collection element -- `index`: collection index -- `collection`: input collection +- **value**: collection element. +- **index**: collection index. +- **collection**: input collection. To set the function execution context, provide a `thisArg`. diff --git a/lib/node_modules/@stdlib/utils/none-in-by/README.md b/lib/node_modules/@stdlib/utils/none-in-by/README.md index 917aa34e3d69..4cfb9140bedb 100644 --- a/lib/node_modules/@stdlib/utils/none-in-by/README.md +++ b/lib/node_modules/@stdlib/utils/none-in-by/README.md @@ -78,9 +78,9 @@ var bool = noneInBy( obj, isUnderage ); The invoked `function` is provided three agruments: -- `value`: property value -- `key`: property key -- `object`: input object +- **value**: property value. +- **key**: property key. +- **object**: input object. To set the function execution context, provide a `thisArg`. diff --git a/lib/node_modules/@stdlib/utils/object-inverse-by/README.md b/lib/node_modules/@stdlib/utils/object-inverse-by/README.md index f0d17a120fca..3fd534f6fb2a 100644 --- a/lib/node_modules/@stdlib/utils/object-inverse-by/README.md +++ b/lib/node_modules/@stdlib/utils/object-inverse-by/README.md @@ -84,9 +84,9 @@ var out = invertBy( obj, opts, transform ); The `transform` function is provided three arguments: -- `key`: object key -- `value`: object value corresponding to `key` -- `obj`: input object +- **key**: object key. +- **value**: object value corresponding to `key`. +- **obj**: input object. ```javascript function transform( key, value, o ) { diff --git a/lib/node_modules/@stdlib/utils/some-by-right/README.md b/lib/node_modules/@stdlib/utils/some-by-right/README.md index ffdee7822ad6..6feba827de21 100644 --- a/lib/node_modules/@stdlib/utils/some-by-right/README.md +++ b/lib/node_modules/@stdlib/utils/some-by-right/README.md @@ -73,9 +73,9 @@ var bool = someByRight( arr, 2, isNegative ); The invoked `function` is provided three arguments: -- `value`: collection element -- `index`: collection index -- `collection`: input collection +- **value**: collection element. +- **index**: collection index. +- **collection**: input collection. To set the function execution context, provide a `thisArg`. diff --git a/lib/node_modules/@stdlib/utils/some-by/README.md b/lib/node_modules/@stdlib/utils/some-by/README.md index 501828765f50..6f6e061bf1db 100644 --- a/lib/node_modules/@stdlib/utils/some-by/README.md +++ b/lib/node_modules/@stdlib/utils/some-by/README.md @@ -73,9 +73,9 @@ var bool = someBy( arr, 2, isPositive ); The invoked `function` is provided three arguments: -- `value`: collection element -- `index`: collection index -- `collection`: input collection +- **value**: collection element. +- **index**: collection index. +- **collection**: input collection. To set the function execution context, provide a `thisArg`. diff --git a/lib/node_modules/@stdlib/utils/some-in-by/README.md b/lib/node_modules/@stdlib/utils/some-in-by/README.md index 350f3a9c65ff..0f55b92d793d 100644 --- a/lib/node_modules/@stdlib/utils/some-in-by/README.md +++ b/lib/node_modules/@stdlib/utils/some-in-by/README.md @@ -79,9 +79,9 @@ var bool = someInBy( obj, 2, isPositive ); The invoked `function` is provided three arguments: -- `value`: object property value -- `key`: object property key -- `obj`: input object +- **value**: object property value. +- **key**: object property key. +- **obj**: input object. To set the function execution context, provide a `thisArg`. diff --git a/lib/node_modules/@stdlib/utils/some-own-by/README.md b/lib/node_modules/@stdlib/utils/some-own-by/README.md index c63f77ec82b0..69db603abc67 100644 --- a/lib/node_modules/@stdlib/utils/some-own-by/README.md +++ b/lib/node_modules/@stdlib/utils/some-own-by/README.md @@ -83,9 +83,9 @@ var bool = someOwnBy( obj, 2, isPositive ); The invoked `function` is provided three arguments: -- `value`: object property value -- `key`: object property key -- `obj`: input object +- **value**: object property value. +- **key**: object property key. +- **obj**: input object. To set the function execution context, provide a `thisArg`. diff --git a/lib/node_modules/@stdlib/utils/try-then/README.md b/lib/node_modules/@stdlib/utils/try-then/README.md index 8c01a7877519..4bb46f266a29 100644 --- a/lib/node_modules/@stdlib/utils/try-then/README.md +++ b/lib/node_modules/@stdlib/utils/try-then/README.md @@ -66,7 +66,7 @@ z = trythen( x2, y ); The function `y` is provided a single argument: -- `error`: the error thrown by `x` +- **error**: the error thrown by `x`. ```javascript var randu = require( '@stdlib/random/base/randu' ); diff --git a/lib/node_modules/@stdlib/utils/until-each/README.md b/lib/node_modules/@stdlib/utils/until-each/README.md index b931ee2eba48..cf65ee6c34e0 100644 --- a/lib/node_modules/@stdlib/utils/until-each/README.md +++ b/lib/node_modules/@stdlib/utils/until-each/README.md @@ -65,9 +65,9 @@ untilEach( arr, predicate, log ); Both the `predicate` function and the `function` to apply are provided three arguments: -- `value`: collection element -- `index`: collection index -- `collection`: input collection +- **value**: collection element. +- **index**: collection index. +- **collection**: input collection. Basic support for dynamic collections is provided. Note, however, that index incrementation is monotonically increasing. diff --git a/lib/node_modules/@stdlib/utils/until/README.md b/lib/node_modules/@stdlib/utils/until/README.md index c28a366637e9..a68964ebd430 100644 --- a/lib/node_modules/@stdlib/utils/until/README.md +++ b/lib/node_modules/@stdlib/utils/until/README.md @@ -65,7 +65,7 @@ until( predicate, beep ); Both the `predicate` function and the `function` to invoke are provided a single argument: -- `i`: iteration number (starting from zero) +- **i**: iteration number (starting from zero). To set the function execution context for the invoked function, provide a `thisArg`. diff --git a/lib/node_modules/@stdlib/utils/while-each/README.md b/lib/node_modules/@stdlib/utils/while-each/README.md index bff7a852a5ef..f2f3dcf3fd73 100644 --- a/lib/node_modules/@stdlib/utils/while-each/README.md +++ b/lib/node_modules/@stdlib/utils/while-each/README.md @@ -65,9 +65,9 @@ whileEach( arr, predicate, log ); Both the `predicate` function and the `function` to apply are provided three arguments: -- `value`: collection element -- `index`: collection index -- `collection`: input collection +- **value**: collection element. +- **index**: collection index. +- **collection**: input collection. Basic support for dynamic collections is provided. Note, however, that index incrementation is monotonically increasing. diff --git a/lib/node_modules/@stdlib/utils/while/README.md b/lib/node_modules/@stdlib/utils/while/README.md index 2c32e5d4ffab..f6b0a535b38c 100644 --- a/lib/node_modules/@stdlib/utils/while/README.md +++ b/lib/node_modules/@stdlib/utils/while/README.md @@ -65,7 +65,7 @@ whilst( predicate, beep ); Both the `predicate` function and the `function` to invoke are provided a single argument: -- `i`: iteration number (starting from zero) +- **i**: iteration number (starting from zero). To set the function execution context for the invoked function, provide a `thisArg`.