Skip to content

Commit bc3632a

Browse files
committed
chore: minor clean-up
1 parent 74b29a5 commit bc3632a

File tree

15 files changed

+26
-30
lines changed

15 files changed

+26
-30
lines changed

lib/node_modules/@stdlib/array/base/fill-by/docs/types/index.d.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@ declare function fillBy<T = unknown, V = unknown, ThisArg = unknown>( x: Accesso
225225
*
226226
* var x = [ 1, 2, 3 ];
227227
*
228-
* var out = fillBy( x, 4, 0, 3 );
228+
* var out = fillBy( x, 0, 3, fcn );
229229
* // returns [ 4, 4, 4 ]
230230
*
231231
* @example
@@ -235,7 +235,7 @@ declare function fillBy<T = unknown, V = unknown, ThisArg = unknown>( x: Accesso
235235
*
236236
* var x = [ 1, 2, 3, 4, 5, 6 ];
237237
*
238-
* var out = fillBy( x, 8, 0, 3 );
238+
* var out = fillBy( x, 0, 3, fcn );
239239
* // returns [ 8, 8, 8, 4, 5, 6 ]
240240
*/
241241
declare function fillBy<T = unknown, V = unknown, ThisArg = unknown>( x: Collection<T>, start: number, end: number, fcn: Callback<T, Collection<T>, V, ThisArg>, thisArg?: ThisParameterType<Callback<T, Collection<T>, V, ThisArg>> ): Collection<T | V>;

lib/node_modules/@stdlib/array/base/map5d/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ interface Routine {
139139
*
140140
* - **value**: array element.
141141
* - **indices**: current array element indices.
142-
* -- **array**: input nested array.
142+
* - **array**: input nested array.
143143
*
144144
* @param x - input nested array
145145
* @param shape - array shape

lib/node_modules/@stdlib/array/base/mskbinary2d/lib/main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
*
3030
* @param {ArrayLikeObject<Array<Collection>>} arrays - array-like object containing two input nested arrays, an input nested mask array, and one output nested array
3131
* @param {NonNegativeIntegerArray} shape - array shape
32-
* @param {Callback} fcn - unary callback
32+
* @param {Callback} fcn - binary callback
3333
* @returns {void}
3434
*
3535
* @example

lib/node_modules/@stdlib/array/base/mskbinary4d/lib/main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
*
3030
* @param {ArrayLikeObject<Array<Collection>>} arrays - array-like object containing two input nested arrays, an input nested mask array, and one output nested array
3131
* @param {NonNegativeIntegerArray} shape - array shape
32-
* @param {Callback} fcn - unary callback
32+
* @param {Callback} fcn - binary callback
3333
* @returns {void}
3434
*
3535
* @example

lib/node_modules/@stdlib/array/base/mskbinary5d/lib/main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
*
3232
* @param {ArrayLikeObject<Array<Collection>>} arrays - array-like object containing two input nested arrays, an input nested mask array, and one output nested array
3333
* @param {NonNegativeIntegerArray} shape - array shape
34-
* @param {Callback} fcn - unary callback
34+
* @param {Callback} fcn - binary callback
3535
* @returns {void}
3636
*
3737
* @example

lib/node_modules/@stdlib/array/base/put/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ declare function put<T extends TypedArray | BooleanTypedArray, U = unknown>( x:
8585
* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
8686
*
8787
* var indices = [ 1, 2 ];
88-
* var values = new Complex128Array( [ 20.0, 30.0, 40, 5.0 ] );
88+
* var values = new Complex128Array( [ 20.0, 30.0, 40.0, 5.0 ] );
8989
*
9090
* var out = put( x, indices, values, 'throw' );
9191
* // returns <Complex128Array>

lib/node_modules/@stdlib/array/base/unary3d-by/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ type Unary<U, V> = ( value: U ) => V;
104104
* var x = ones3d( shape );
105105
* var y = zeros3d( shape );
106106
*
107-
* unary3dBy( [ x, y ], shape, scale );
107+
* unary3dBy( [ x, y ], shape, scale, accessor );
108108
*
109109
* console.log( y );
110110
* // => [ [ [ -10.0, -10.0 ], [ -10.0, -10.0 ] ] ]

lib/node_modules/@stdlib/array/nans-like/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -259,7 +259,7 @@ declare function nansLike( x: Complex64Array, dtype?: DataType ): Complex64Array
259259
* // returns [ 0, 0 ]
260260
*
261261
* var y = nansLike( x );
262-
* // returns [ 1, 1 ]
262+
* // returns [ NaN, NaN ]
263263
*/
264264
declare function nansLike( x: Array<any>, dtype?: DataType ): Array<number>;
265265

lib/node_modules/@stdlib/array/shared-buffer/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ try {
110110
}
111111
```
112112

113-
By default, the method copies from the beginning of the [`SharedArrayBuffer`][mdn-sharedarraybuffer]. To beginning copying from a different byte index, provide a `start` argument, specifying the starting byte index (inclusive).
113+
By default, the method copies from the beginning of the [`SharedArrayBuffer`][mdn-sharedarraybuffer]. To begin copying from a different byte index, provide a `start` argument, specifying the starting byte index (inclusive).
114114

115115
<!-- eslint-disable stdlib/require-globals, no-unused-vars, no-inner-declarations -->
116116

lib/node_modules/@stdlib/array/struct-factory/lib/main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ var CTOR_NAME = 'StructArray';
7777
* }
7878
* ];
7979
*
80-
* // Create a struct constructor for storing real and imaginary componenets:
80+
* // Create a struct constructor for storing real and imaginary components:
8181
* var Components = structFactory( schema1 );
8282
*
8383
* var schema2 = [

lib/node_modules/@stdlib/array/take/docs/types/index.d.ts

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ interface Options {
5151
*
5252
* var x = zeroTo( 4, 'float64' );
5353
* var y = take( x, [ 1, 3 ] );
54-
* // returns <Float64Array>[ 2.0, 4.0 ]
54+
* // returns <Float64Array>[ 1.0, 3.0 ]
5555
*/
5656
declare function take( x: Float64Array, indices: IndexArray, options?: Options ): Float64Array;
5757

@@ -68,7 +68,7 @@ declare function take( x: Float64Array, indices: IndexArray, options?: Options )
6868
*
6969
* var x = zeroTo( 4, 'float32' );
7070
* var y = take( x, [ 1, 3 ] );
71-
* // returns <Float32Array>[ 2.0, 4.0 ]
71+
* // returns <Float32Array>[ 1.0, 3.0 ]
7272
*/
7373
declare function take( x: Float32Array, indices: IndexArray, options?: Options ): Float32Array;
7474

@@ -85,7 +85,7 @@ declare function take( x: Float32Array, indices: IndexArray, options?: Options )
8585
*
8686
* var x = zeroTo( 4, 'int32' );
8787
* var y = take( x, [ 1, 3 ] );
88-
* // returns <Int32Array>[ 2, 4 ]
88+
* // returns <Int32Array>[ 1, 3 ]
8989
*/
9090
declare function take( x: Int32Array, indices: IndexArray, options?: Options ): Int32Array;
9191

@@ -102,7 +102,7 @@ declare function take( x: Int32Array, indices: IndexArray, options?: Options ):
102102
*
103103
* var x = zeroTo( 4, 'int16' );
104104
* var y = take( x, [ 1, 3 ] );
105-
* // returns <Int16Array>[ 2, 4 ]
105+
* // returns <Int16Array>[ 1, 3 ]
106106
*/
107107
declare function take( x: Int16Array, indices: IndexArray, options?: Options ): Int16Array;
108108

@@ -119,7 +119,7 @@ declare function take( x: Int16Array, indices: IndexArray, options?: Options ):
119119
*
120120
* var x = zeroTo( 4, 'int8' );
121121
* var y = take( x, [ 1, 3 ] );
122-
* // returns <Int8Array>[ 2, 4 ]
122+
* // returns <Int8Array>[ 1, 3 ]
123123
*/
124124
declare function take( x: Int8Array, indices: IndexArray, options?: Options ): Int8Array;
125125

@@ -136,7 +136,7 @@ declare function take( x: Int8Array, indices: IndexArray, options?: Options ): I
136136
*
137137
* var x = zeroTo( 4, 'uint32' );
138138
* var y = take( x, [ 1, 3 ] );
139-
* // returns <Uint32Array>[ 2, 4 ]
139+
* // returns <Uint32Array>[ 1, 3 ]
140140
*/
141141
declare function take( x: Uint32Array, indices: IndexArray, options?: Options ): Uint32Array;
142142

@@ -153,7 +153,7 @@ declare function take( x: Uint32Array, indices: IndexArray, options?: Options ):
153153
*
154154
* var x = zeroTo( 4, 'uint16' );
155155
* var y = take( x, [ 1, 3 ] );
156-
* // returns <Uint16Array>[ 2, 4 ]
156+
* // returns <Uint16Array>[ 1, 3 ]
157157
*/
158158
declare function take( x: Uint16Array, indices: IndexArray, options?: Options ): Uint16Array;
159159

@@ -170,7 +170,7 @@ declare function take( x: Uint16Array, indices: IndexArray, options?: Options ):
170170
*
171171
* var x = zeroTo( 4, 'uint8' );
172172
* var y = take( x, [ 1, 3 ] );
173-
* // returns <Uint8Array>[ 2, 4 ]
173+
* // returns <Uint8Array>[ 1, 3 ]
174174
*/
175175
declare function take( x: Uint8Array, indices: IndexArray, options?: Options ): Uint8Array;
176176

@@ -187,7 +187,7 @@ declare function take( x: Uint8Array, indices: IndexArray, options?: Options ):
187187
*
188188
* var x = zeroTo( 4, 'uint8c' );
189189
* var y = take( x, [ 1, 3 ] );
190-
* // returns <Uint8ClampedArray>[ 2, 4 ]
190+
* // returns <Uint8ClampedArray>[ 1, 3 ]
191191
*/
192192
declare function take( x: Uint8ClampedArray, indices: IndexArray, options?: Options ): Uint8ClampedArray;
193193

@@ -204,7 +204,7 @@ declare function take( x: Uint8ClampedArray, indices: IndexArray, options?: Opti
204204
*
205205
* var x = zeroTo( 4, 'complex128' );
206206
* var y = take( x, [ 1, 3 ] );
207-
* // returns <Complex128Array>[ 2.0, 0.0, 4.0, 0.0 ]
207+
* // returns <Complex128Array>[ 1.0, 0.0, 3.0, 0.0 ]
208208
*/
209209
declare function take( x: Complex128Array, indices: IndexArray, options?: Options ): Complex128Array;
210210

@@ -221,7 +221,7 @@ declare function take( x: Complex128Array, indices: IndexArray, options?: Option
221221
*
222222
* var x = zeroTo( 4, 'complex64' );
223223
* var y = take( x, [ 1, 3 ] );
224-
* // returns <Complex64Array>[ 2.0, 0.0, 4.0, 0.0 ]
224+
* // returns <Complex64Array>[ 1.0, 0.0, 3.0, 0.0 ]
225225
*/
226226
declare function take( x: Complex64Array, indices: IndexArray, options?: Options ): Complex64Array;
227227

lib/node_modules/@stdlib/array/to-sparse-iterator-right/README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -168,8 +168,6 @@ var count = ctx.count;
168168
<!-- eslint no-undef: "error" -->
169169

170170
```javascript
171-
var Float64Array = require( '@stdlib/array/float64' );
172-
var inmap = require( '@stdlib/utils/inmap' );
173171
var randu = require( '@stdlib/random/base/randu' );
174172
var sparsearray2iteratorRight = require( '@stdlib/array/to-sparse-iterator-right' );
175173

lib/node_modules/@stdlib/array/to-sparse-iterator/README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -168,8 +168,6 @@ var count = ctx.count;
168168
<!-- eslint no-undef: "error" -->
169169

170170
```javascript
171-
var Float64Array = require( '@stdlib/array/float64' );
172-
var inmap = require( '@stdlib/utils/inmap' );
173171
var randu = require( '@stdlib/random/base/randu' );
174172
var sparsearray2iterator = require( '@stdlib/array/to-sparse-iterator' );
175173

lib/node_modules/@stdlib/array/uint8c/docs/repl.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -355,7 +355,7 @@
355355
The returned array has the same data type as the host array.
356356

357357
If a predicate function does not return a truthy value for any array
358-
element, the method returns `null`.
358+
element, the method returns an empty array.
359359

360360
Parameters
361361
----------
@@ -761,7 +761,7 @@
761761
the host array.
762762

763763
If the method is unable to resolve indices to a non-empty array subsequence,
764-
the method returns `null`.
764+
the method returns an empty array.
765765

766766
Parameters
767767
----------
@@ -804,7 +804,7 @@
804804
----------
805805
predicate: Function
806806
Predicate function which tests array elements. If a predicate function
807-
returns a truthy value, a array element passes; otherwise, an array
807+
returns a truthy value, an array element passes; otherwise, an array
808808
element fails.
809809

810810
thisArg: Any (optional)

lib/node_modules/@stdlib/assert/contains/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ var v = contains( 'hello', 'e', 2.5 );
113113
## Notes
114114

115115
- For strings, the function is modeled after [String.prototype.includes][mdn-includes], part of the ECMAScript 6 specification. This function is different from a call to `String.prototype.includes.call` insofar as type-checking is performed for all arguments.
116-
- The function **does** distinguish between positive and negative zero (see [`@stdlib/assert/is-same-value`][@stdlib/assert/is-same-value].
116+
- The function **does** distinguish between positive and negative zero (see [`@stdlib/assert/is-same-value`][@stdlib/assert/is-same-value]).
117117
- If `position < 0`, the search is performed for the entire input array or string.
118118

119119
</section>

0 commit comments

Comments
 (0)