Skip to content

Commit 411223a

Browse files
committed
docs: carry over example code fixes to namespace declarations
1 parent ac2734e commit 411223a

File tree

3 files changed

+29
-29
lines changed

3 files changed

+29
-29
lines changed

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -272,7 +272,7 @@ interface Namespace {
272272
*
273273
* @example
274274
* var arr = new ns.AccessorArray( [ 1, 2, 3 ] );
275-
* // returns <ns.AccessorArray>
275+
* // returns <AccessorArray>
276276
*
277277
* var v = arr.get( 0 );
278278
* // returns 1
@@ -329,7 +329,7 @@ interface Namespace {
329329
* set( arr, 2, 10 );
330330
*
331331
* var v = arr.get( 2 );
332-
* // returns 3
332+
* // returns 10
333333
*/
334334
accessorSetter: typeof accessorSetter;
335335

@@ -357,7 +357,7 @@ interface Namespace {
357357
* var bool = obj.accessorProtocol;
358358
* // returns false
359359
*
360-
* var fcns = obj.ns.accessors;
360+
* var fcns = obj.accessors;
361361
* // returns [ <Function>, <Function> ]
362362
*
363363
* var v = fcns[ 0 ]( x, 2 );
@@ -1995,7 +1995,7 @@ interface Namespace {
19951995
* var y = [ false, null, false, null, false, null, false, null, false, null ];
19961996
*
19971997
* var arr = ns.cuanyByRight.assign( x, y, 2, 0, isPositive );
1998-
* // returns [ false, null, false, null, false, null, true, null, true, null ]
1998+
* // returns [ false, null, ..., true, null ]
19991999
*/
20002000
cuanyByRight: typeof cuanyByRight;
20012001

@@ -2414,7 +2414,7 @@ interface Namespace {
24142414
* @returns output array
24152415
*
24162416
* @example
2417-
* var Slice = require( '@stdlib/ns.fancySlice/ctor' );
2417+
* var Slice = require( '@stdlib/slice/ctor' );
24182418
*
24192419
* var x = [ 1, 2, 3, 4, 5, 6 ];
24202420
*
@@ -5910,7 +5910,7 @@ interface Namespace {
59105910
* var x = ones4d( shape );
59115911
* var y = zeros4d( shape );
59125912
*
5913-
* ns.unary4dBy( [ x, y ], shape, scale );
5913+
* ns.unary4dBy( [ x, y ], shape, scale, accessor );
59145914
*
59155915
* console.log( y );
59165916
* // => [ [ [ [ -10.0, -10.0 ], [ -10.0, -10.0 ] ] ] ]

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

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -138,21 +138,21 @@ interface Namespace {
138138
*
139139
* @example
140140
* var arr = new ns.BooleanArray();
141-
* // returns <ns.BooleanArray>
141+
* // returns <BooleanArray>
142142
*
143143
* var len = arr.length;
144144
* // returns 0
145145
*
146146
* @example
147147
* var arr = new ns.BooleanArray( 2 );
148-
* // returns <ns.BooleanArray>
148+
* // returns <BooleanArray>
149149
*
150150
* var len = arr.length;
151151
* // returns 2
152152
*
153153
* @example
154154
* var arr = new ns.BooleanArray( [ true, false ] );
155-
* // returns <ns.BooleanArray>
155+
* // returns <BooleanArray>
156156
*
157157
* var len = arr.length;
158158
* // returns 2
@@ -162,7 +162,7 @@ interface Namespace {
162162
*
163163
* var buf = new ArrayBuffer( 16 );
164164
* var arr = new ns.BooleanArray( buf );
165-
* // returns <ns.BooleanArray>
165+
* // returns <BooleanArray>
166166
*
167167
* var len = arr.length;
168168
* // returns 16
@@ -172,7 +172,7 @@ interface Namespace {
172172
*
173173
* var buf = new ArrayBuffer( 16 );
174174
* var arr = new ns.BooleanArray( buf, 8 );
175-
* // returns <ns.BooleanArray>
175+
* // returns <BooleanArray>
176176
*
177177
* var len = arr.length;
178178
* // returns 8
@@ -182,7 +182,7 @@ interface Namespace {
182182
*
183183
* var buf = new ArrayBuffer( 32 );
184184
* var arr = new ns.BooleanArray( buf, 8, 2 );
185-
* // returns <ns.BooleanArray>
185+
* // returns <BooleanArray>
186186
*
187187
* var len = arr.length;
188188
* // returns 2
@@ -288,21 +288,21 @@ interface Namespace {
288288
*
289289
* @example
290290
* var arr = new ns.Complex64Array();
291-
* // returns <ns.Complex64Array>
291+
* // returns <Complex64Array>
292292
*
293293
* var len = arr.length;
294294
* // returns 0
295295
*
296296
* @example
297297
* var arr = new ns.Complex64Array( 2 );
298-
* // returns <ns.Complex64Array>
298+
* // returns <Complex64Array>
299299
*
300300
* var len = arr.length;
301301
* // returns 2
302302
*
303303
* @example
304304
* var arr = new ns.Complex64Array( [ 1.0, -1.0 ] );
305-
* // returns <ns.Complex64Array>
305+
* // returns <Complex64Array>
306306
*
307307
* var len = arr.length;
308308
* // returns 1
@@ -312,7 +312,7 @@ interface Namespace {
312312
*
313313
* var buf = new ArrayBuffer( 16 );
314314
* var arr = new ns.Complex64Array( buf );
315-
* // returns <ns.Complex64Array>
315+
* // returns <Complex64Array>
316316
*
317317
* var len = arr.length;
318318
* // returns 2
@@ -322,7 +322,7 @@ interface Namespace {
322322
*
323323
* var buf = new ArrayBuffer( 16 );
324324
* var arr = new ns.Complex64Array( buf, 8 );
325-
* // returns <ns.Complex64Array>
325+
* // returns <Complex64Array>
326326
*
327327
* var len = arr.length;
328328
* // returns 1
@@ -332,7 +332,7 @@ interface Namespace {
332332
*
333333
* var buf = new ArrayBuffer( 32 );
334334
* var arr = new ns.Complex64Array( buf, 8, 2 );
335-
* // returns <ns.Complex64Array>
335+
* // returns <Complex64Array>
336336
*
337337
* var len = arr.length;
338338
* // returns 2
@@ -384,13 +384,13 @@ interface Namespace {
384384
* // returns <Complex128Array>
385385
*
386386
* var len = arr.length;
387-
* // returns 1
387+
* // returns 2
388388
*
389389
* @example
390390
* var ArrayBuffer = require( '@stdlib/array/buffer' );
391391
*
392-
* var buf = new ArrayBuffer( 32 );
393-
* var arr = new ns.Complex128Array( buf, 16 );
392+
* var buf = new ArrayBuffer( 16 );
393+
* var arr = new ns.Complex128Array( buf, 8 );
394394
* // returns <Complex128Array>
395395
*
396396
* var len = arr.length;
@@ -399,8 +399,8 @@ interface Namespace {
399399
* @example
400400
* var ArrayBuffer = require( '@stdlib/array/buffer' );
401401
*
402-
* var buf = new ArrayBuffer( 48 );
403-
* var arr = new ns.Complex128Array( buf, 16, 2 );
402+
* var buf = new ArrayBuffer( 32 );
403+
* var arr = new ns.Complex128Array( buf, 8, 2 );
404404
* // returns <Complex128Array>
405405
*
406406
* var len = arr.length;
@@ -770,7 +770,7 @@ interface Namespace {
770770
* var x = new Uint8Array( [ 1, 0, 1, 0 ] );
771771
*
772772
* var idx = new ns.ArrayIndex( x );
773-
* // returns <ns.ArrayIndex>
773+
* // returns <ArrayIndex>
774774
*/
775775
ArrayIndex: typeof ArrayIndex;
776776

lib/node_modules/@stdlib/slice/docs/types/index.d.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ interface Namespace {
4848
*
4949
* @example
5050
* var s = new ns.Slice( 10 );
51-
* // returns <ns.Slice>
51+
* // returns <Slice>
5252
*
5353
* var start = s.start;
5454
* // returns null
@@ -61,7 +61,7 @@ interface Namespace {
6161
*
6262
* @example
6363
* var s = new ns.Slice( 3, 10 );
64-
* // returns <ns.Slice>
64+
* // returns <Slice>
6565
*
6666
* var start = s.start;
6767
* // returns 3
@@ -74,7 +74,7 @@ interface Namespace {
7474
*
7575
* @example
7676
* var s = new ns.Slice( 3, 10, 2 );
77-
* // returns <ns.Slice>
77+
* // returns <Slice>
7878
*
7979
* var start = s.start;
8080
* // returns 3
@@ -94,13 +94,13 @@ interface Namespace {
9494
* @returns MultiSlice instance
9595
*
9696
* @example
97-
* var Slice = require( '@stdlib/slice/ns.MultiSlice' );
97+
* var Slice = require( '@stdlib/slice/ctor' );
9898
*
9999
* var s = new Slice( 10 );
100100
* // returns <Slice>
101101
*
102102
* var ms = new ns.MultiSlice( 2, s, 1 );
103-
* // returns <ns.MultiSlice>
103+
* // returns <MultiSlice>
104104
*/
105105
MultiSlice: typeof MultiSlice;
106106

0 commit comments

Comments
 (0)