Skip to content

Commit 20fd492

Browse files
stdlib-botstdlib-bot
committed
Auto-generated commit
1 parent 6d3f8fa commit 20fd492

File tree

9 files changed

+30
-29
lines changed

9 files changed

+30
-29
lines changed

‎CHANGELOG.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -552,6 +552,7 @@ A total of 24 issues were closed in this release:
552552

553553
<details>
554554

555+
- [`ecde0da`](https://github.com/stdlib-js/stdlib/commit/ecde0dab6fa80df5a13632b83ef780ba46861dd8) - **chore:** fix return annotation comments and spacing _(by Philipp Burckhardt)_
555556
- [`29bbe63`](https://github.com/stdlib-js/stdlib/commit/29bbe6352ed375283da50d7363cc537b72736765) - **refactor:** allow non-string dtypes and delegate to `ndarray/base/assign` for copying ndarray views _(by Athan Reines)_
556557
- [`fc43bac`](https://github.com/stdlib-js/stdlib/commit/fc43bac47c9c2419da27a568dce6d05e05dc904a) - **feat:** add `isEqualDataType` to namespace _(by Athan Reines)_
557558
- [`aa727fa`](https://github.com/stdlib-js/stdlib/commit/aa727fa586eed12d282eb46e49cdbd8e28e18712) - **feat:** add `ndarray/base/assert/is-equal-data-type` _(by Athan Reines)_

‎base/assert/is-equal-data-type/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ bool = isEqualDataType( 'generic', new DataType( 'generic' ) );
9191
bool = isEqualDataType( 'int16', 'int32' );
9292
// returns false
9393

94-
bool = isEqualDataType( 'int32', new DataType( 'int16') );
94+
bool = isEqualDataType( 'int32', new DataType( 'int16' ) );
9595
// returns false
9696

9797
bool = isEqualDataType( 'foo', 'foo' );

‎base/assert/is-equal-data-type/examples/index.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ bool = isEqualDataType( 'int16', 'int32' );
4141
console.log( bool );
4242
// => false
4343

44-
bool = isEqualDataType( 'int32', new DataType( 'int16') );
44+
bool = isEqualDataType( 'int32', new DataType( 'int16' ) );
4545
console.log( bool );
4646
// => false
4747

‎flatten-by/docs/types/index.d.ts‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ type Options<U> = BaseOptions & {
130130
* var offset = 0;
131131
*
132132
* var x = ndarray( 'float64', buffer, shape, strides, offset, 'row-major' );
133-
* // return <ndarray>
133+
* // returns <ndarray>
134134
*
135135
* var y = flattenBy( x, scale );
136136
* // returns <ndarray>
@@ -163,7 +163,7 @@ declare function flattenBy<T extends typedndarray<number> = typedndarray<number>
163163
* var offset = 0;
164164
*
165165
* var x = ndarray( 'complex64', buffer, shape, strides, offset, 'row-major' );
166-
* // return <ndarray>
166+
* // returns <ndarray>
167167
*
168168
* var y = flattenBy( x, identity );
169169
* // returns <ndarray>
@@ -193,7 +193,7 @@ declare function flattenBy<T extends ComplexLike = ComplexLike, U extends typedn
193193
* var offset = 0;
194194
*
195195
* var x = ndarray( 'uint8c', buffer, shape, strides, offset, 'row-major' );
196-
* // return <ndarray>
196+
* // returns <ndarray>
197197
*
198198
* var y = flattenBy( x, scale );
199199
* // returns <ndarray>
@@ -225,7 +225,7 @@ declare function flattenBy<T extends typedndarray<boolean> = typedndarray<boolea
225225
* var offset = 0;
226226
*
227227
* var x = ndarray( 'generic', buffer, shape, strides, offset, 'row-major' );
228-
* // return <ndarray>
228+
* // returns <ndarray>
229229
*
230230
* var y = flattenBy( x, scale );
231231
* // returns <ndarray>
@@ -262,7 +262,7 @@ declare function flattenBy<T = unknown, U extends genericndarray<T> = genericnda
262262
* var offset = 0;
263263
*
264264
* var x = ndarray( 'float64', buffer, shape, strides, offset, 'row-major' );
265-
* // return <ndarray>
265+
* // returns <ndarray>
266266
*
267267
* var opts = {
268268
* 'depth': 2
@@ -303,7 +303,7 @@ declare function flattenBy<T extends typedndarray<number> = typedndarray<number>
303303
* var offset = 0;
304304
*
305305
* var x = ndarray( 'complex64', buffer, shape, strides, offset, 'row-major' );
306-
* // return <ndarray>
306+
* // returns <ndarray>
307307
*
308308
* var opts = {
309309
* 'depth': 1
@@ -341,7 +341,7 @@ declare function flattenBy<T extends ComplexLike = ComplexLike, U extends typedn
341341
* var offset = 0;
342342
*
343343
* var x = ndarray( 'uint8c', buffer, shape, strides, offset, 'row-major' );
344-
* // return <ndarray>
344+
* // returns <ndarray>
345345
*
346346
* var opts = {
347347
* 'depth': 2
@@ -381,7 +381,7 @@ declare function flattenBy<T extends typedndarray<boolean> = typedndarray<boolea
381381
* var offset = 0;
382382
*
383383
* var x = ndarray( 'generic', buffer, shape, strides, offset, 'row-major' );
384-
* // return <ndarray>
384+
* // returns <ndarray>
385385
*
386386
* var opts = {
387387
* 'depth': 2
@@ -422,7 +422,7 @@ declare function flattenBy<T = unknown, U extends genericndarray<T> = genericnda
422422
* var offset = 0;
423423
*
424424
* var x = ndarray( 'float64', buffer, shape, strides, offset, 'row-major' );
425-
* // return <ndarray>
425+
* // returns <ndarray>
426426
*
427427
* var opts = {
428428
* 'depth': 2

‎flatten-by/lib/index.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
* }
3434
*
3535
* var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ], [ [ 5.0, 6.0 ] ] ] );
36-
* // return <ndarray>
36+
* // returns <ndarray>
3737
*
3838
* var y = flattenBy( x, scale );
3939
* // returns <ndarray>

‎flatten-by/lib/main.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ var COL_MAJOR = 'column-major';
7373
* }
7474
*
7575
* var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ], [ [ 5.0, 6.0 ] ] ] );
76-
* // return <ndarray>
76+
* // returns <ndarray>
7777
*
7878
* var y = flattenBy( x, scale );
7979
* // returns <ndarray>

‎flatten/docs/types/index.d.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ type Options<U> = BaseOptions & {
8282
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
8383
*
8484
* var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ], [ [ 5.0, 6.0 ] ] ] );
85-
* // return <ndarray>
85+
* // returns <ndarray>
8686
*
8787
* var y = flatten( x );
8888
* // returns <ndarray>
@@ -111,7 +111,7 @@ declare function flatten<T extends ndarray>( x: T, options?: BaseOptions ): T;
111111
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
112112
*
113113
* var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ], [ [ 5.0, 6.0 ] ] ] );
114-
* // return <ndarray>
114+
* // returns <ndarray>
115115
*
116116
* var y = flatten( x );
117117
* // returns <ndarray>

‎flatten/lib/index.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
*
3131
* // Create an input ndarray:
3232
* var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ], [ [ 5.0, 6.0 ] ] ] );
33-
* // return <ndarray>
33+
* // returns <ndarray>
3434
*
3535
* // Flatten the input ndarray:
3636
* var y = flatten( x );

‎flatten/lib/main.js‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ var COL_MAJOR = 'column-major';
6565
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
6666
*
6767
* var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ], [ [ 5.0, 6.0 ] ] ] );
68-
* // return <ndarray>
68+
* // returns <ndarray>
6969
*
7070
* var y = flatten( x );
7171
* // returns <ndarray>
@@ -81,7 +81,7 @@ var COL_MAJOR = 'column-major';
8181
* 'shape': [ 2, 3 ],
8282
* 'order': 'column-major'
8383
* });
84-
* // return <ndarray>
84+
* // returns <ndarray>
8585
*
8686
* var y = flatten( x );
8787
* // returns <ndarray>
@@ -97,7 +97,7 @@ var COL_MAJOR = 'column-major';
9797
* 'shape': [ 2, 3 ],
9898
* 'order': 'row-major'
9999
* });
100-
* // return <ndarray>
100+
* // returns <ndarray>
101101
*
102102
* var y = flatten( x, {
103103
* 'order': 'column-major'
@@ -115,7 +115,7 @@ var COL_MAJOR = 'column-major';
115115
* 'shape': [ 2, 3 ],
116116
* 'order': 'column-major'
117117
* });
118-
* // return <ndarray>
118+
* // returns <ndarray>
119119
*
120120
* var y = flatten( x, {
121121
* 'order': 'row-major'
@@ -133,7 +133,7 @@ var COL_MAJOR = 'column-major';
133133
* 'shape': [ 2, 3 ],
134134
* 'order': 'row-major'
135135
* });
136-
* // return <ndarray>
136+
* // returns <ndarray>
137137
*
138138
* var y = flatten( x, {
139139
* 'order': 'same'
@@ -151,7 +151,7 @@ var COL_MAJOR = 'column-major';
151151
* 'shape': [ 2, 3 ],
152152
* 'order': 'column-major'
153153
* });
154-
* // return <ndarray>
154+
* // returns <ndarray>
155155
*
156156
* var y = flatten( x, {
157157
* 'order': 'same'
@@ -168,7 +168,7 @@ var COL_MAJOR = 'column-major';
168168
* var xbuf = [ 1.0, null, 2.0, null, 3.0, null, 4.0, null, 5.0, null, 6.0, null ];
169169
*
170170
* var x = new ndarray( 'generic', xbuf, [ 2, 3 ], [ -6, -2 ], 10, 'row-major' );
171-
* // return <ndarray>
171+
* // returns <ndarray>
172172
*
173173
* var y = flatten( x );
174174
* // returns <ndarray>
@@ -184,7 +184,7 @@ var COL_MAJOR = 'column-major';
184184
*
185185
* // Create an ndarray whose stated order is column-major, but which has been transposed:
186186
* var x = new ndarray( 'generic', xbuf, [ 2, 3 ], [ -6, -2 ], 10, 'column-major' );
187-
* // return <ndarray>
187+
* // returns <ndarray>
188188
*
189189
* var y = flatten( x );
190190
* // returns <ndarray>
@@ -200,7 +200,7 @@ var COL_MAJOR = 'column-major';
200200
*
201201
* // Create an ndarray whose stated order is column-major, but which has been transposed:
202202
* var x = new ndarray( 'generic', xbuf, [ 2, 3 ], [ -6, -2 ], 10, 'column-major' );
203-
* // return <ndarray>
203+
* // returns <ndarray>
204204
*
205205
* var y = flatten( x, {
206206
* 'order': 'same'
@@ -218,7 +218,7 @@ var COL_MAJOR = 'column-major';
218218
*
219219
* // Create an ndarray whose stated order is column-major, but which has been transposed:
220220
* var x = new ndarray( 'generic', xbuf, [ 2, 3 ], [ -6, -2 ], 10, 'column-major' );
221-
* // return <ndarray>
221+
* // returns <ndarray>
222222
*
223223
* var y = flatten( x, {
224224
* 'order': 'any'
@@ -236,7 +236,7 @@ var COL_MAJOR = 'column-major';
236236
*
237237
* // Create an ndarray whose stated order is row-major, but which has been transposed:
238238
* var x = new ndarray( 'generic', xbuf, [ 2, 3 ], [ -2, -4 ], 10, 'row-major' );
239-
* // return <ndarray>
239+
* // returns <ndarray>
240240
*
241241
* var y = flatten( x );
242242
* // returns <ndarray>
@@ -252,7 +252,7 @@ var COL_MAJOR = 'column-major';
252252
*
253253
* // Create an ndarray whose stated order is row-major, but which has been transposed:
254254
* var x = new ndarray( 'generic', xbuf, [ 2, 3 ], [ -2, -4 ], 10, 'row-major' );
255-
* // return <ndarray>
255+
* // returns <ndarray>
256256
*
257257
* var y = flatten( x, {
258258
* 'order': 'same'
@@ -270,7 +270,7 @@ var COL_MAJOR = 'column-major';
270270
*
271271
* // Create an ndarray whose stated order is row-major, but which has been transposed:
272272
* var x = new ndarray( 'generic', xbuf, [ 2, 3 ], [ -2, -4 ], 10, 'row-major' );
273-
* // return <ndarray>
273+
* // returns <ndarray>
274274
*
275275
* var y = flatten( x, {
276276
* 'order': 'any'

0 commit comments

Comments
 (0)