Skip to content

Commit cadb613

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

52 files changed

Lines changed: 140 additions & 140 deletions

File tree

Some content is hidden

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

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

Lines changed: 2 additions & 2 deletions
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‎

Lines changed: 3 additions & 3 deletions
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‎

Lines changed: 2 additions & 2 deletions
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‎

Lines changed: 2 additions & 2 deletions
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‎

Lines changed: 2 additions & 2 deletions
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‎

Lines changed: 3 additions & 3 deletions
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‎

Lines changed: 3 additions & 3 deletions
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‎

Lines changed: 3 additions & 3 deletions
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‎

Lines changed: 3 additions & 3 deletions
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‎

Lines changed: 2 additions & 2 deletions
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

0 commit comments

Comments
 (0)