Skip to content

Commit cadb613

Browse files
committed
chore: update argument documentation styling
1 parent 40502bb commit cadb613

File tree

52 files changed

+140
-140
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+140
-140
lines changed

lib/node_modules/@stdlib/array/from-iterator/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -85,8 +85,8 @@ var arr = iterator2array( array2iterator( [ 1, 2, 3, 4 ] ), fcn );
8585

8686
The invoked function is provided two arguments:
8787

88-
- `value`: iterated value
89-
- `index`: iterated value index
88+
- **value**: iterated value.
89+
- **index**: iterated value index.
9090

9191
```javascript
9292
var Float64Array = require( '@stdlib/array/float64' );

lib/node_modules/@stdlib/fs/resolve-parent-path-by/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -81,8 +81,8 @@ function onPath( error, path ) {
8181

8282
When invoked, the `predicate` function is provided two arguments:
8383

84-
- `path`: a resolved path.
85-
- `next`: a callback which should be called once the `predicate` function has finished processing a resolved path.
84+
- **path**: a resolved path.
85+
- **next**: a callback which should be called once the `predicate` function has finished processing a resolved path.
8686

8787
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.
8888

@@ -105,7 +105,7 @@ The function accepts the same `options` as [`resolveParentPathBy()`](#resolve-pa
105105

106106
When invoked, the `predicate` function is provided one argument:
107107

108-
- `path`: a resolved path.
108+
- **path**: a resolved path.
109109

110110
The function immediately returns upon encountering a truthy `predicate` function return value.
111111

lib/node_modules/@stdlib/iter/filter-map/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -73,8 +73,8 @@ The returned [iterator][mdn-iterator-protocol] protocol-compliant object has the
7373

7474
The callback function is provided two arguments:
7575

76-
- `value`: iterated value
77-
- `index`: iteration index (zero-based)
76+
- **value**: iterated value.
77+
- **index**: iteration index (zero-based).
7878

7979
```javascript
8080
var array2iterator = require( '@stdlib/array/to-iterator' );

lib/node_modules/@stdlib/iter/filter/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,8 @@ The returned [iterator][mdn-iterator-protocol] protocol-compliant object has the
7171

7272
The `predicate` function is provided two arguments:
7373

74-
- `value`: iterated value
75-
- `index`: iteration index (zero-based)
74+
- **value**: iterated value.
75+
- **index**: iteration index (zero-based).
7676

7777
```javascript
7878
var array2iterator = require( '@stdlib/array/to-iterator' );

lib/node_modules/@stdlib/iter/map/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -73,8 +73,8 @@ The returned [iterator][mdn-iterator-protocol] protocol-compliant object has the
7373

7474
The invoked `function` is provided two arguments:
7575

76-
- `value`: iterated value
77-
- `index`: iteration index (zero-based)
76+
- **value**: iterated value.
77+
- **index**: iteration index (zero-based).
7878

7979
```javascript
8080
var array2iterator = require( '@stdlib/array/to-iterator' );

lib/node_modules/@stdlib/utils/any-by-right/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -73,9 +73,9 @@ var bool = anyByRight( arr, isNegative );
7373

7474
The invoked `function` is provided three arguments:
7575

76-
- `value`: collection element
77-
- `index`: collection index
78-
- `collection`: input collection
76+
- **value**: collection element.
77+
- **index**: collection index.
78+
- **collection**: input collection.
7979

8080
To set the function execution context, provide a `thisArg`.
8181

lib/node_modules/@stdlib/utils/any-by/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -73,9 +73,9 @@ var bool = anyBy( arr, isPositive );
7373

7474
The invoked `function` is provided three arguments:
7575

76-
- `value`: collection element
77-
- `index`: collection index
78-
- `collection`: input collection
76+
- **value**: collection element.
77+
- **index**: collection index.
78+
- **collection**: input collection.
7979

8080
To set the function execution context, provide a `thisArg`.
8181

lib/node_modules/@stdlib/utils/any-in-by/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -81,9 +81,9 @@ var bool = anyInBy( obj, isPositive );
8181

8282
The invoked `function` is provided three arguments:
8383

84-
- `value`: property value
85-
- `key`: property key
86-
- `object`: input object
84+
- **value**: property value.
85+
- **key**: property key.
86+
- **object**: input object.
8787

8888
To set the function execution context, provide a `thisArg`.
8989

lib/node_modules/@stdlib/utils/any-own-by/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -85,9 +85,9 @@ var bool = anyOwnBy( obj, isPositive );
8585

8686
The invoked `function` is provided three arguments:
8787

88-
- `value`: property value
89-
- `key`: property key
90-
- `obj`: input object
88+
- **value**: property value.
89+
- **key**: property key.
90+
- **obj**: input object.
9191

9292
To set the function execution context, provide a `thisArg`.
9393

lib/node_modules/@stdlib/utils/async/compose/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -81,8 +81,8 @@ f( 6, done ); // ((2*x)+3)/5
8181

8282
The last argument provided to each composed function is a `next` callback which accepts two arguments:
8383

84-
- `error`: error argument
85-
- `result`: function result
84+
- **error**: error argument.
85+
- **result**: function result.
8686

8787
**Only** the rightmost function is explicitly permitted to accept multiple arguments. All other functions are evaluated as **binary** functions.
8888

lib/node_modules/@stdlib/utils/async/function-sequence/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -81,8 +81,8 @@ f( 6, done ); // ((2*x)+3)/5
8181

8282
The last argument provided to each function is a `next` callback which accepts two arguments:
8383

84-
- `error`: error argument
85-
- `result`: function result
84+
- **error**: error argument.
85+
- **result**: function result.
8686

8787
**Only** the leftmost function is explicitly permitted to accept multiple arguments. All other functions are evaluated as **binary** functions.
8888

lib/node_modules/@stdlib/utils/bifurcate-by/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,8 @@ var out = bifurcateBy( arr, predicate );
5656

5757
A `predicate` function is provided two arguments:
5858

59-
- `value`: collection element
60-
- `index`: collection index
59+
- **value**: collection element.
60+
- **index**: collection index.
6161

6262
```javascript
6363
function predicate( v, i ) {
@@ -72,8 +72,8 @@ var out = bifurcateBy( arr, predicate );
7272

7373
The function accepts the following `options`:
7474

75-
- `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'`.
76-
- `thisArg`: execution context.
75+
- **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'`.
76+
- **thisArg**: execution context.
7777

7878
By default, the function returns element values. To return element indices, set the `returns` option to `'indices'`.
7979

lib/node_modules/@stdlib/utils/bifurcate-in/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,8 @@ var out = bifurcateIn( obj, predicate );
6767

6868
A `predicate` function is provided two arguments:
6969

70-
- `value`: object value
71-
- `key`: object index
70+
- **value**: object value.
71+
- **key**: object index.
7272

7373
```javascript
7474
function predicate( v, k ) {
@@ -93,8 +93,8 @@ var out = bifurcateIn( obj, predicate );
9393

9494
The function accepts the following `options`:
9595

96-
- `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'`.
97-
- `thisArg`: execution context.
96+
- **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'`.
97+
- **thisArg**: execution context.
9898

9999
By default, the function returns object values. To return object keys, set the `returns` option to `'keys'`.
100100

lib/node_modules/@stdlib/utils/bifurcate-own/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,8 @@ var out = bifurcateOwn( obj, predicate );
6161

6262
A `predicate` function is provided two arguments:
6363

64-
- `value`: object value
65-
- `key`: object index
64+
- **value**: object value.
65+
- **key**: object index.
6666

6767
```javascript
6868
function predicate( v, k ) {
@@ -82,8 +82,8 @@ var out = bifurcateOwn( obj, predicate );
8282

8383
The function accepts the following `options`:
8484

85-
- `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'`.
86-
- `thisArg`: execution context.
85+
- **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'`.
86+
- **thisArg**: execution context.
8787

8888
By default, the function returns object values. To return object keys, set the `returns` option to `'keys'`.
8989

lib/node_modules/@stdlib/utils/bifurcate/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ var out = bifurcate( arr, filter );
5454

5555
The function accepts the following `options`:
5656

57-
- `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'`.
57+
- **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'`.
5858

5959
By default, the function returns element values. To return element indices, set the `returns` option to `'indices'`.
6060

lib/node_modules/@stdlib/utils/count-by/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,8 @@ var out = countBy( arr, indicator );
5656

5757
An `indicator` function is provided two arguments:
5858

59-
- `value`: collection element
60-
- `index`: collection index
59+
- **value**: collection element.
60+
- **index**: collection index.
6161

6262
```javascript
6363
function indicator( v, i ) {
@@ -72,7 +72,7 @@ var out = countBy( arr, indicator );
7272

7373
The function accepts the following `options`:
7474

75-
- `thisArg`: execution context.
75+
- **thisArg**: execution context.
7676

7777
To set the `indicator` execution context, provide a `thisArg`.
7878

lib/node_modules/@stdlib/utils/do-until-each-right/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -66,9 +66,9 @@ doUntilEachRight( arr, log, predicate );
6666

6767
Both the `predicate` function and the `function` to apply are provided three arguments:
6868

69-
- `value`: collection element
70-
- `index`: collection index
71-
- `collection`: input collection
69+
- **value**: collection element.
70+
- **index**: collection index.
71+
- **collection**: input collection.
7272

7373
If provided an empty `collection`, both `value` and `index` are `undefined`.
7474

lib/node_modules/@stdlib/utils/do-until-each/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -66,9 +66,9 @@ doUntilEach( arr, log, predicate );
6666

6767
Both the `predicate` function and the `function` to apply are provided three arguments:
6868

69-
- `value`: collection element
70-
- `index`: collection index
71-
- `collection`: input collection
69+
- **value**: collection element.
70+
- **index**: collection index.
71+
- **collection**: input collection.
7272

7373
If provided an empty `collection`, both `value` and `index` are `undefined`.
7474

lib/node_modules/@stdlib/utils/do-until/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ doUntil( beep, predicate );
6565

6666
Both the `predicate` function and the `function` to invoke are provided a single argument:
6767

68-
- `i`: iteration number (starting from zero)
68+
- **i**: iteration number (starting from zero).
6969

7070
To set the function execution context for the invoked function, provide a `thisArg`.
7171

lib/node_modules/@stdlib/utils/do-while-each-right/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -66,9 +66,9 @@ doWhileEachRight( arr, log, predicate );
6666

6767
Both the `predicate` function and the `function` to apply are provided three arguments:
6868

69-
- `value`: collection element
70-
- `index`: collection index
71-
- `collection`: input collection
69+
- **value**: collection element.
70+
- **index**: collection index.
71+
- **collection**: input collection.
7272

7373
If provided an empty `collection`, both `value` and `index` are `undefined`.
7474

lib/node_modules/@stdlib/utils/do-while-each/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -66,9 +66,9 @@ doWhileEach( arr, log, predicate );
6666

6767
Both the `predicate` function and the `function` to apply are provided three arguments:
6868

69-
- `value`: collection element
70-
- `index`: collection index
71-
- `collection`: input collection
69+
- **value**: collection element.
70+
- **index**: collection index.
71+
- **collection**: input collection.
7272

7373
If provided an empty `collection`, both `value` and `index` are `undefined`.
7474

lib/node_modules/@stdlib/utils/do-while/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ doWhile( beep, predicate );
6565

6666
Both the `predicate` function and the `function` to invoke are provided a single argument:
6767

68-
- `i`: iteration number (starting from zero)
68+
- **i**: iteration number (starting from zero).
6969

7070
To set the function execution context for the invoked function, provide a `thisArg`.
7171

lib/node_modules/@stdlib/utils/every-by-right/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -70,9 +70,9 @@ var bool = everyByRight( arr, isPositive );
7070

7171
The invoked `function` is provided three arguments:
7272

73-
- `value`: collection element
74-
- `index`: collection index
75-
- `collection`: input collection
73+
- **value**: collection element.
74+
- **index**: collection index.
75+
- **collection**: input collection.
7676

7777
To set the function execution context, provide a `thisArg`.
7878

lib/node_modules/@stdlib/utils/every-by/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -70,9 +70,9 @@ var bool = everyBy( arr, isPositive );
7070

7171
The invoked `function` is provided three arguments:
7272

73-
- `value`: collection element
74-
- `index`: collection index
75-
- `collection`: input collection
73+
- **value**: collection element.
74+
- **index**: collection index.
75+
- **collection**: input collection.
7676

7777
To set the function execution context, provide a `thisArg`.
7878

lib/node_modules/@stdlib/utils/every-own-by/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -80,9 +80,9 @@ var bool = everyOwnBy( obj, isPositive );
8080

8181
The invoked `function` is provided three arguments:
8282

83-
- `value`: property value
84-
- `key`: property key
85-
- `obj`: input object
83+
- **value**: property value.
84+
- **key**: property key.
85+
- **obj**: input object.
8686

8787
To set the function execution context, provide a `thisArg`.
8888

lib/node_modules/@stdlib/utils/for-each-right/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -62,9 +62,9 @@ forEachRight( arr, log );
6262

6363
The invoked `function` is provided three arguments:
6464

65-
- `value`: collection element
66-
- `index`: collection index
67-
- `collection`: input collection
65+
- **value**: collection element.
66+
- **index**: collection index.
67+
- **collection**: input collection.
6868

6969
Basic support for dynamic collections is provided. Note, however, that index incrementation is **not** guaranteed to be monotonically **decreasing**.
7070

lib/node_modules/@stdlib/utils/for-each/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -62,9 +62,9 @@ forEach( arr, log );
6262

6363
The invoked `function` is provided three arguments:
6464

65-
- `value`: collection element
66-
- `index`: collection index
67-
- `collection`: input collection
65+
- **value**: collection element.
66+
- **index**: collection index.
67+
- **collection**: input collection.
6868

6969
Basic support for dynamic collections is provided. Note, however, that index incrementation is monotonically increasing.
7070

lib/node_modules/@stdlib/utils/for-in/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -71,9 +71,9 @@ forIn( obj, log );
7171

7272
The invoked `function` is provided three arguments:
7373

74-
- `value`: object property value
75-
- `key`: object property
76-
- `obj`: the input object
74+
- **value**: object property value.
75+
- **key**: object property.
76+
- **obj**: the input object.
7777

7878
To terminate iteration before visiting all properties, the provided function must explicitly return `false`.
7979

lib/node_modules/@stdlib/utils/for-own/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -67,9 +67,9 @@ forOwn( obj, log );
6767

6868
The invoked `function` is provided three arguments:
6969

70-
- `value`: object property value
71-
- `key`: object property
72-
- `obj`: the input object
70+
- **value**: object property value.
71+
- **key**: object property.
72+
- **obj**: the input object.
7373

7474
To terminate iteration before visiting all properties, the provided function must explicitly return `false`.
7575

0 commit comments

Comments
 (0)