Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -4,7 +4,7 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2024-09-11)
+## Unreleased (2024-09-17)
 
 <section class="packages">
 
@@ -34,6 +34,7 @@ A total of 3 people contributed to this release. Thank you to the following cont
 
 <details>
 
+-   [`cadb613`](https://github.com/stdlib-js/stdlib/commit/cadb6131d6ce50338d11757e88e8a910a0367983) - **chore:** update argument documentation styling _(by Philipp Burckhardt)_
 -   [`3c5fc0d`](https://github.com/stdlib-js/stdlib/commit/3c5fc0d3d544356489d3da56507766eadd556fd1) - **style:** replace tabs with spaces in examples indentation _(by Philipp Burckhardt)_
 -   [`8edb71d`](https://github.com/stdlib-js/stdlib/commit/8edb71d3f64bdf44f51c35e24cfce3ff9932f844) - **test:** add tests to `utils/circular-buffer` _(by Karthik Prakash, Philipp Burckhardt, Athan Reines)_
 

CONTRIBUTORS

@@ -2,6 +2,7 @@
 #
 # Contributors listed in alphabetical order.
 
+Aayush Khanna <[email protected]>
 Adarsh Palaskar <[email protected]>
 Aditya Sapra <[email protected]>
 AgPriyanshu18 <[email protected]>

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`.
 

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`.
 

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`.
 

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`.
 

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.
 

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.
 

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'`.
 

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'`.