Skip to content

Commit 6e9f42e

Browse files
PlaneshifterPlaneshifter
committed
docs: harmonize list formatting in repl.txt and ensure starting newline
1 parent 2fd573e commit 6e9f42e

File tree

215 files changed

+1084
-1078
lines changed

Some content is hidden

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

215 files changed

+1084
-1078
lines changed

‎lib/node_modules/@stdlib/array/base/accessor-getter/docs/repl.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55

66
An accessor function accepts the following arguments:
77

8-
- arr: input array
9-
- idx: element index
8+
- arr: input array.
9+
- idx: element index.
1010

1111
If provided an unsupported `dtype`, the function returns a default accessor
1212
function for accessing elements from any indexed array-like object

‎lib/node_modules/@stdlib/array/base/accessor-setter/docs/repl.txt

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55

66
An accessor function accepts the following arguments:
77

8-
- arr: input array
9-
- idx: element index
10-
- value: value to set
8+
- arr: input array.
9+
- idx: element index.
10+
- value: value to set.
1111

1212
If provided an unsupported `dtype`, the function returns a default accessor
1313
function for accessing elements in any indexed array-like object supporting

‎lib/node_modules/@stdlib/array/base/cunone-by-right/docs/repl.txt

+7-6
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
1+
12
{{alias}}( x, predicate[, thisArg] )
23
Cumulatively tests whether no array element in a provided array passes a
34
test implemented by a predicate function, while iterating from
45
right-to-left.
56

67
The predicate function is provided three arguments:
78

8-
- `value`: current array element.
9-
- `index`: current array element index.
10-
- `arr`: the input array.
9+
- value: current array element.
10+
- index: current array element index.
11+
- arr: the input array.
1112

1213
Parameters
1314
----------
@@ -40,9 +41,9 @@
4041

4142
The predicate function is provided three arguments:
4243

43-
- `value`: current array element.
44-
- `index`: current array element index.
45-
- `arr`: the input array.
44+
- value: current array element.
45+
- index: current array element index.
46+
- arr: the input array.
4647

4748
Parameters
4849
----------

‎lib/node_modules/@stdlib/array/base/cunone-by/docs/repl.txt

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55

66
The predicate function is provided three arguments:
77

8-
- `value`: current array element.
9-
- `index`: current array element index.
10-
- `arr`: the input array.
8+
- value: current array element.
9+
- index: current array element index.
10+
- arr: the input array.
1111

1212
Parameters
1313
----------

‎lib/node_modules/@stdlib/array/base/cusome-by-right/docs/repl.txt

+8-7
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
1+
12
{{alias}}( x, n, predicate[, thisArg] )
2-
Cumulatively test whether at least `n` elements in a provided array pass a
3+
Cumulatively tests whether at least `n` elements in a provided array pass a
34
test implemented by a predicate function, while iterating from
45
right-to-left.
56

67
The predicate function is provided three arguments:
78

8-
- `value`: current array element.
9-
- `index`: current array element index.
10-
- `arr`: the input array.
9+
- value: current array element.
10+
- index: current array element index.
11+
- arr: the input array.
1112

1213
Parameters
1314
----------
@@ -43,9 +44,9 @@
4344

4445
The predicate function is provided three arguments:
4546

46-
- `value`: current array element.
47-
- `index`: current array element index.
48-
- `arr`: the input array.
47+
- value: current array element.
48+
- index: current array element index.
49+
- arr: the input array.
4950

5051
Parameters
5152
----------

‎lib/node_modules/@stdlib/array/base/getter/docs/repl.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55

66
An accessor function accepts the following arguments:
77

8-
- arr: input array
9-
- idx: element index
8+
- arr: input array.
9+
- idx: element index.
1010

1111
If provided an unsupported `dtype`, the function returns a default accessor
1212
function for accessing elements from any indexed array-like object.

‎lib/node_modules/@stdlib/array/base/resolve-getter/docs/repl.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55

66
An accessor function accepts the following arguments:
77

8-
- arr: input array
9-
- idx: element index
8+
- arr: input array.
9+
- idx: element index.
1010

1111
If provided an array-like object having an unsupported data type, the
1212
function returns a default accessor function for accessing elements from

‎lib/node_modules/@stdlib/array/base/resolve-setter/docs/repl.txt

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44

55
An accessor function accepts the following arguments:
66

7-
- arr: input array
8-
- idx: element index
9-
- value: value to set
7+
- arr: input array.
8+
- idx: element index.
9+
- value: value to set.
1010

1111
If provided an array-like object having an unsupported data type, the
1212
function returns a default accessor function for accessing elements in any

‎lib/node_modules/@stdlib/array/base/setter/docs/repl.txt

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55

66
An accessor function accepts the following arguments:
77

8-
- arr: input array
9-
- idx: element index
10-
- value: value to set
8+
- arr: input array.
9+
- idx: element index.
10+
- value: value to set.
1111

1212
If provided an unsupported `dtype`, the function returns a default accessor
1313
function for accessing elements in any indexed array-like object.

‎lib/node_modules/@stdlib/array/base/unary2d-by/docs/repl.txt

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66

77
The callback function is provided the following arguments:
88

9-
- value: array element
10-
- indices: current array element indices
11-
- arrays: input and output arrays
9+
- value: array element.
10+
- indices: current array element indices.
11+
- arrays: input and output arrays.
1212

1313
If the callback function does not return any value (or equivalently,
1414
explicitly returns `undefined`), the value is ignored.

‎lib/node_modules/@stdlib/array/from-iterator/docs/repl.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44

55
When invoked, an input function is provided two arguments:
66

7-
- value: iterated value
8-
- index: iterated value index (zero-based)
7+
- value: iterated value.
8+
- index: iterated value index (zero-based).
99

1010
If provided an output array, the function fills the output array with
1111
iterated values.

‎lib/node_modules/@stdlib/array/nans-like/docs/repl.txt

+5-5
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@
55

66
The function supports the following data types:
77

8-
- float64: double-precision floating-point numbers (IEEE 754)
9-
- float32: single-precision floating-point numbers (IEEE 754)
10-
- complex128: double-precision complex floating-point numbers
11-
- complex64: single-precision complex floating-point numbers
12-
- generic: generic JavaScript values
8+
- float64: double-precision floating-point numbers (IEEE 754).
9+
- float32: single-precision floating-point numbers (IEEE 754).
10+
- complex128: double-precision complex floating-point numbers.
11+
- complex64: single-precision complex floating-point numbers.
12+
- generic: generic JavaScript values.
1313

1414
Parameters
1515
----------

‎lib/node_modules/@stdlib/array/one-to-like/docs/repl.txt

+12-12
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,18 @@
66

77
The function supports the following data types:
88

9-
- float64: double-precision floating-point numbers (IEEE 754)
10-
- float32: single-precision floating-point numbers (IEEE 754)
11-
- complex128: double-precision complex floating-point numbers
12-
- complex64: single-precision complex floating-point numbers
13-
- int32: 32-bit two's complement signed integers
14-
- uint32: 32-bit unsigned integers
15-
- int16: 16-bit two's complement signed integers
16-
- uint16: 16-bit unsigned integers
17-
- int8: 8-bit two's complement signed integers
18-
- uint8: 8-bit unsigned integers
19-
- uint8c: 8-bit unsigned integers clamped to 0-255
20-
- generic: generic JavaScript values
9+
- float64: double-precision floating-point numbers (IEEE 754).
10+
- float32: single-precision floating-point numbers (IEEE 754).
11+
- complex128: double-precision complex floating-point numbers.
12+
- complex64: single-precision complex floating-point numbers.
13+
- int32: 32-bit two's complement signed integers.
14+
- uint32: 32-bit unsigned integers.
15+
- int16: 16-bit two's complement signed integers.
16+
- uint16: 16-bit unsigned integers.
17+
- int8: 8-bit two's complement signed integers.
18+
- uint8: 8-bit unsigned integers.
19+
- uint8c: 8-bit unsigned integers clamped to 0-255.
20+
- generic: generic JavaScript values.
2121

2222
Parameters
2323
----------

‎lib/node_modules/@stdlib/array/one-to/docs/repl.txt

+12-12
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,18 @@
55

66
The function supports the following data types:
77

8-
- float64: double-precision floating-point numbers (IEEE 754)
9-
- float32: single-precision floating-point numbers (IEEE 754)
10-
- complex128: double-precision complex floating-point numbers
11-
- complex64: single-precision complex floating-point numbers
12-
- int32: 32-bit two's complement signed integers
13-
- uint32: 32-bit unsigned integers
14-
- int16: 16-bit two's complement signed integers
15-
- uint16: 16-bit unsigned integers
16-
- int8: 8-bit two's complement signed integers
17-
- uint8: 8-bit unsigned integers
18-
- uint8c: 8-bit unsigned integers clamped to 0-255
19-
- generic: generic JavaScript values
8+
- float64: double-precision floating-point numbers (IEEE 754).
9+
- float32: single-precision floating-point numbers (IEEE 754).
10+
- complex128: double-precision complex floating-point numbers.
11+
- complex64: single-precision complex floating-point numbers.
12+
- int32: 32-bit two's complement signed integers.
13+
- uint32: 32-bit unsigned integers.
14+
- int16: 16-bit two's complement signed integers.
15+
- uint16: 16-bit unsigned integers.
16+
- int8: 8-bit two's complement signed integers.
17+
- uint8: 8-bit unsigned integers.
18+
- uint8c: 8-bit unsigned integers clamped to 0-255.
19+
- generic: generic JavaScript values.
2020

2121
The default array data type is `float64`.
2222

‎lib/node_modules/@stdlib/array/ones-like/docs/repl.txt

+12-12
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,18 @@
55

66
The function supports the following data types:
77

8-
- float64: double-precision floating-point numbers (IEEE 754)
9-
- float32: single-precision floating-point numbers (IEEE 754)
10-
- complex128: double-precision complex floating-point numbers
11-
- complex64: single-precision complex floating-point numbers
12-
- int32: 32-bit two's complement signed integers
13-
- uint32: 32-bit unsigned integers
14-
- int16: 16-bit two's complement signed integers
15-
- uint16: 16-bit unsigned integers
16-
- int8: 8-bit two's complement signed integers
17-
- uint8: 8-bit unsigned integers
18-
- uint8c: 8-bit unsigned integers clamped to 0-255
19-
- generic: generic JavaScript values
8+
- float64: double-precision floating-point numbers (IEEE 754).
9+
- float32: single-precision floating-point numbers (IEEE 754).
10+
- complex128: double-precision complex floating-point numbers.
11+
- complex64: single-precision complex floating-point numbers.
12+
- int32: 32-bit two's complement signed integers.
13+
- uint32: 32-bit unsigned integers.
14+
- int16: 16-bit two's complement signed integers.
15+
- uint16: 16-bit unsigned integers.
16+
- int8: 8-bit two's complement signed integers.
17+
- uint8: 8-bit unsigned integers.
18+
- uint8c: 8-bit unsigned integers clamped to 0-255.
19+
- generic: generic JavaScript values.
2020

2121
Parameters
2222
----------

‎lib/node_modules/@stdlib/array/ones/docs/repl.txt

+12-12
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,18 @@
44

55
The function supports the following data types:
66

7-
- float64: double-precision floating-point numbers (IEEE 754)
8-
- float32: single-precision floating-point numbers (IEEE 754)
9-
- complex128: double-precision complex floating-point numbers
10-
- complex64: single-precision complex floating-point numbers
11-
- int32: 32-bit two's complement signed integers
12-
- uint32: 32-bit unsigned integers
13-
- int16: 16-bit two's complement signed integers
14-
- uint16: 16-bit unsigned integers
15-
- int8: 8-bit two's complement signed integers
16-
- uint8: 8-bit unsigned integers
17-
- uint8c: 8-bit unsigned integers clamped to 0-255
18-
- generic: generic JavaScript values
7+
- float64: double-precision floating-point numbers (IEEE 754).
8+
- float32: single-precision floating-point numbers (IEEE 754).
9+
- complex128: double-precision complex floating-point numbers.
10+
- complex64: single-precision complex floating-point numbers.
11+
- int32: 32-bit two's complement signed integers.
12+
- uint32: 32-bit unsigned integers.
13+
- int16: 16-bit two's complement signed integers.
14+
- uint16: 16-bit unsigned integers.
15+
- int8: 8-bit two's complement signed integers.
16+
- uint8: 8-bit unsigned integers.
17+
- uint8c: 8-bit unsigned integers clamped to 0-255.
18+
- generic: generic JavaScript values.
1919

2020
The default array data type is `float64`.
2121

‎lib/node_modules/@stdlib/array/reviver/docs/repl.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
The serialization format for typed array is an object having the following
66
fields:
77

8-
- type: typed array type (e.g., "Float64Array", "Int8Array")
9-
- data: typed array data as an array of numbers
8+
- type: typed array type (e.g., "Float64Array", "Int8Array").
9+
- data: typed array data as an array of numbers.
1010

1111
Parameters
1212
----------

‎lib/node_modules/@stdlib/array/to-circular-iterator/docs/repl.txt

+4-4
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@
55

66
When invoked, an input function is provided four arguments:
77

8-
- value: iterated value
9-
- index: iterated value index
10-
- n: iteration count
11-
- src: source array-like object
8+
- value: iterated value.
9+
- index: iterated value index.
10+
- n: iteration count.
11+
- src: source array-like object.
1212

1313
If an environment supports Symbol.iterator, the returned iterator is
1414
iterable.

‎lib/node_modules/@stdlib/array/to-iterator-right/docs/repl.txt

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55

66
When invoked, an input function is provided three arguments:
77

8-
- value: iterated value
9-
- index: iterated value index
10-
- src: source array-like object
8+
- value: iterated value.
9+
- index: iterated value index.
10+
- src: source array-like object.
1111

1212
If an environment supports Symbol.iterator, the returned iterator is
1313
iterable.

‎lib/node_modules/@stdlib/array/to-iterator/docs/repl.txt

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55

66
When invoked, an input function is provided three arguments:
77

8-
- value: iterated value
9-
- index: iterated value index
10-
- src: source array-like object
8+
- value: iterated value.
9+
- index: iterated value index.
10+
- src: source array-like object.
1111

1212
If an environment supports Symbol.iterator, the returned iterator is
1313
iterable.

‎lib/node_modules/@stdlib/array/to-json/docs/repl.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@
1919

2020
The returned JSON object has the following properties:
2121

22-
- type: typed array type
23-
- data: typed array data as a generic array
22+
- type: typed array type.
23+
- data: typed array data as a generic array.
2424

2525
The implementation supports custom typed arrays and sets the `type` field to
2626
the closest known typed array type.

‎lib/node_modules/@stdlib/array/to-sparse-iterator-right/docs/repl.txt

+3-3
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@
77

88
When invoked, an input function is provided three arguments:
99

10-
- value: iterated value
11-
- index: iterated value index
12-
- src: source array-like object
10+
- value: iterated value.
11+
- index: iterated value index.
12+
- src: source array-like object.
1313

1414
If an environment supports Symbol.iterator, the returned iterator is
1515
iterable.

0 commit comments

Comments
 (0)